{"id":24362715,"url":"https://github.com/machu-gwu/afwf_github-project","last_synced_at":"2026-05-09T06:03:51.484Z","repository":{"id":50674291,"uuid":"485181886","full_name":"MacHu-GWU/afwf_github-project","owner":"MacHu-GWU","description":"Alfred GitHub Workflow.","archived":false,"fork":false,"pushed_at":"2026-04-21T20:56:02.000Z","size":647,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-21T22:35:12.122Z","etag":null,"topics":["alfred","alfred-workflow","alfred4-workflow","github","python"],"latest_commit_sha":null,"homepage":"https://afwf-github.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MacHu-GWU.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-04-25T01:12:06.000Z","updated_at":"2026-04-21T20:55:29.000Z","dependencies_parsed_at":"2024-02-21T05:26:54.266Z","dependency_job_id":"7d558651-fc77-4eac-9bdb-d287f401eb58","html_url":"https://github.com/MacHu-GWU/afwf_github-project","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/MacHu-GWU/afwf_github-project","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacHu-GWU%2Fafwf_github-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacHu-GWU%2Fafwf_github-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacHu-GWU%2Fafwf_github-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacHu-GWU%2Fafwf_github-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MacHu-GWU","download_url":"https://codeload.github.com/MacHu-GWU/afwf_github-project/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacHu-GWU%2Fafwf_github-project/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32809148,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"online","status_checked_at":"2026-05-09T02:00:06.633Z","response_time":123,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alfred","alfred-workflow","alfred4-workflow","github","python"],"created_at":"2025-01-18T22:53:16.920Z","updated_at":"2026-05-09T06:03:51.478Z","avatar_url":"https://github.com/MacHu-GWU.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n.. image:: https://readthedocs.org/projects/afwf-github/badge/?version=latest\n    :target: https://afwf-github.readthedocs.io/en/latest/\n    :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/afwf_github-project/actions/workflows/main.yml/badge.svg\n    :target: https://github.com/MacHu-GWU/afwf_github-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/afwf_github-project/branch/main/graph/badge.svg\n    :target: https://codecov.io/gh/MacHu-GWU/afwf_github-project\n\n.. image:: https://img.shields.io/pypi/v/afwf-github.svg\n    :target: https://pypi.python.org/pypi/afwf-github\n\n.. image:: https://img.shields.io/pypi/l/afwf-github.svg\n    :target: https://pypi.python.org/pypi/afwf-github\n\n.. image:: https://img.shields.io/pypi/pyversions/afwf-github.svg\n    :target: https://pypi.python.org/pypi/afwf-github\n\n.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social\u0026logo=github\n    :target: https://github.com/MacHu-GWU/afwf_github-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social\u0026logo=github\n    :target: https://github.com/MacHu-GWU/afwf_github-project\n\n------\n\n.. image:: https://img.shields.io/badge/Link-API-blue.svg\n    :target: https://afwf-github.readthedocs.io/en/latest/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n    :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n    :target: https://github.com/MacHu-GWU/afwf_github-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n    :target: https://github.com/MacHu-GWU/afwf_github-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n    :target: https://github.com/MacHu-GWU/afwf_github-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n    :target: https://pypi.org/pypi/afwf-github#files\n\n\nWelcome to ``afwf_github`` Documentation\n==============================================================================\n.. image:: https://afwf-github.readthedocs.io/en/latest/_static/afwf_github-logo.png\n    :target: https://afwf-github.readthedocs.io/en/latest/\n\nIt is an `Alfred Workflow \u003chttps://www.alfredapp.com/workflows/\u003e`_ for GitHub operations. There already is a PHP `alfred-github-workflow \u003chttps://github.com/gharlan/alfred-github-workflow\u003e`_ 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 \u003chttps://github.com/quickwit-oss/tantivy\u003e`_ (via `sayt2 \u003chttps://github.com/MacHu-GWU/sayt2-project\u003e`_), a Rust-based full-text search engine.\n\n\nInstall\n------------------------------------------------------------------------------\n1. Make sure you have `Alfred 5 + \u003chttps://www.alfredapp.com/\u003e`_ installed and bought the `Power Pack \u003chttps://www.alfredapp.com/shop/\u003e`_.\n2. Go to `Release \u003chttps://github.com/MacHu-GWU/afwf_github-project/releases\u003e`_, download the latest release.\n3. Double click the file to install.\n4. Prepare your GitHub Personal Access Token: go to https://github.com/settings/tokens, create a new token, make sure you checked ``repo -\u003e public_repo``, ``admin:org -\u003e read:org``, ``admin:enterprise -\u003e 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)``.\n\n\nUsage\n------------------------------------------------------------------------------\n1. Configuration.\n\n    In Alfred UI, type ``gh-config``, it should open the ~/.alfred-afwf/afwf_github/config.json``\n\n    .. image:: https://github.com/MacHu-GWU/afwf_github-project/assets/6800411/2acff3ad-8a90-4326-8f64-3a54df2da11f\n\n2. Build Index\n\n    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/``\n\n    .. image:: https://github.com/MacHu-GWU/afwf_github-project/assets/6800411/59ce941d-a22a-4fb5-8013-c6a14ec5ca56\n\n3. Search GitHub\n\n    In Alfred UI, type ``gh ${query}``, it should show the following UI:\n\n    .. image:: https://github.com/MacHu-GWU/afwf_github-project/assets/6800411/57ea7aa5-d2e0-4b73-8e66-632453418d92\n\n4. Open Git Repo in Browser\n\n    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.\n\n    .. image:: https://github.com/MacHu-GWU/afwf_github-project/assets/6800411/e863fac8-e9b0-4301-93c0-d745059e4346\n\n\nTrouble Shooting\n------------------------------------------------------------------------------\n1. ``gh ${query}`` doesn't show any result.\n\n    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.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmachu-gwu%2Fafwf_github-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmachu-gwu%2Fafwf_github-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmachu-gwu%2Fafwf_github-project/lists"}