MacHu-GWU/afwf_github-project

Alfred GitHub Workflow

---

Welcome to afwf_github Documentation

It is an Alfred Workflow for GitHub operations. There already is a PHP alfred-github-workflow library for this. But the searching is based on Alfred built-in word level filtering, which doesn't allow any typo, fuzzy, and full text search. This project aim to provide the best searching experience powered by the Single Machine, Pure Python version of ElasticSearch - whoosh

Install

1. Make sure you have Alfred 4 + installed and bought the Power Pack.
2. Go to Release, download the latest release.
3. Double click the file to install.
4. Prepare your GitHub Personal Access Token: go to https://github.com/settings/tokens, create a new token, make sure you checked repo -> public_repo, admin:org -> read:org, admin:enterprise -> read:enterprise so the workflow can get your public repo name and url information. If you want to get your private repo as well, you should check repo (Full control of private repositories).
5. Setup the GitHub personal access token file and python interpreter config file. So the workflow knows where to read the token and which python to use.

# Create data directory
mkdir ~/.alfred-afwf_github

# Create the GitHub Personal Access Token file
# replace ${GITHUB_PERSONAL_ACCESS_TOKEN} with your token
echo "${GITHUB_PERSONAL_ACCESS_TOKEN}" > ~/.alfred-afwf_github/default

# Create the Python Interpreter file
# Now it support Python3.7+ only
# If you are using python3, you can use ``which python3`` command to find
# the full path of Python interpreter
# replace ${PYTHON_INTERPRETER_PATH} with the path
echo "${PYTHON_INTERPRETER_PATH}" > ~/.alfred-afwf_github/python_interpreter