Skip to content

albertlauncher/albert-plugin-github

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

albert-plugin-github

Features

  • Provides query handlers for GitHub user, repository and issue search.
  • Triggered queries perform a GitHub search.
  • Global queries return customizable saved searches.
  • The root trigger queryhandler returns the saved searches of the dedicated search handlers.
  • Authentication allows for private access and higher rate limits.

Note

GitHub has a complex rate limiting system. Limits of unauthenticated API queries are hit quickly. Use authentication to avoid getting limited (see the section below).

Setup

  1. Create an OAuth app on GitHub. (GitHub docs)
  2. Give it a name.
  3. Give it a random website.
  4. Add Redirect URI albert://github/.
  5. Click Register application.
  6. Click Generate a new client secret.
  7. Insert Client ID and Client secret in the plugin settings and click the authorize button.

Technical notes

  • Uses the GitHub Web API (API version: v2022-11-28).
  • See the used endpoints and scopes in github.h.

About

GitHub search

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published