Release v1.0.4 (What’s new?).

Documentation Status https://github.com/MacHu-GWU/afwf_github-project/actions/workflows/main.yml/badge.svg https://codecov.io/gh/MacHu-GWU/afwf_github-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/afwf-github.svg https://img.shields.io/pypi/l/afwf-github.svg https://img.shields.io/pypi/pyversions/afwf-github.svg https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to afwf_github Documentation

https://afwf-github.readthedocs.io/en/latest/_static/afwf_github-logo.png

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 aims to provide the best searching experience powered by tantivy (via sayt2), a Rust-based full-text search engine.

Install

  1. Make sure you have Alfred 5 + 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).

Usage

  1. Configuration.

    In Alfred UI, type gh-config, it should open the ~/.alfred-afwf/afwf_github/config.json``

    https://github.com/MacHu-GWU/afwf_github-project/assets/6800411/2acff3ad-8a90-4326-8f64-3a54df2da11f

  2. Build Index

    In Alfred UI, type gh-rebuild-index, it should start to crawl your GitHub repos. It will take a while to finish. You can check the progress in the ~/.alfred-afwf/afwf_github/.repo_index/

    https://github.com/MacHu-GWU/afwf_github-project/assets/6800411/59ce941d-a22a-4fb5-8013-c6a14ec5ca56

  3. Search GitHub

    In Alfred UI, type gh ${query}, it should show the following UI:

    https://github.com/MacHu-GWU/afwf_github-project/assets/6800411/57ea7aa5-d2e0-4b73-8e66-632453418d92

  4. Open Git Repo in Browser

    Copy any absolute path of a file in any git repo, type gh-view-in-browser ${path} then hit Enter, it should open the repo in browser.

    https://github.com/MacHu-GWU/afwf_github-project/assets/6800411/e863fac8-e9b0-4301-93c0-d745059e4346

Trouble Shooting

  1. gh ${query} doesn’t show any result.

    Check the ${HOME}/.alfred-afwf/afwf_github/ folder, if there’s no folder name equal to your github username(where to store the index), it means the Workflow failed to crawl your GitHub repos. Please double check ${HOME}/.alfred-afwf/afwf_github/config.json to make sure you have the correct GitHub Personal Access Token.

Table of Content

About the Author

(\ (\
( -.-)o
o_(")(")

Sanhe Hu is a seasoned software engineer with a deep passion for Python development since 2010. As an author and maintainer of 150+ open-source Python projects, with over 15 million monthly downloads, I bring a wealth of experience to the table. As a Senior Solution Architect and Subject Matter Expert in AI, Data, Amazon Web Services, Cloud Engineering, DevOps, I thrive on helping clients with platform design, enterprise architecture, and strategic roadmaps.

Talk is cheap, show me the code:

API Document