https://github.com/johnthegr8/wox.plugin.github

Wox plugin to search github repos, browse issues and PRs
https://github.com/johnthegr8/wox.plugin.github

github wox wox-plugin

Last synced: 10 days ago
JSON representation

Wox plugin to search github repos, browse issues and PRs

• Host: GitHub
• URL: https://github.com/johnthegr8/wox.plugin.github
• Owner: JohnTheGr8
• License: mit
• Created: 2017-03-09T21:49:34.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-03-28T22:57:35.000Z (over 3 years ago)
• Last Synced: 2024-08-03T17:14:10.577Z (3 months ago)
• Topics: github, wox, wox-plugin
• Language: F#
• Size: 76.2 KB
• Stars: 12
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Wox.Plugin.Github [![Build status](https://ci.appveyor.com/api/projects/status/pfq56cm1rcui0crp?svg=true)](https://ci.appveyor.com/project/JohnTheGr8/wox-plugin-github)

==================

Github plugin for the [Wox launcher](https://github.com/Wox-launcher/Wox)

### About

Search Github repositories, navigate repository issues and pull requests, directly from Wox.

![demo gif](http://i.imgur.com/ZL14NKU.gif)

### Usage

Search for repos: `` gh repos {repo-search-term} ``

Display repository info: `` gh repo {full-repo-name} ``

List repository issues: `` gh issues {full-repo-name} ``

List repository pull requests: `` gh pr {full-repo-name} ``

Search for users: `` gh users {user-search-term} ``

Find specific issue or pull request: `` gh {full-repo-name} #123 ``

List repositories by user: `` gh {owner-name}/ ``

### Access Token

To avoid rate limits from Github's API, after installing the plugin do the following:

1. open Github and [generate a new personal access token](https://github.com/settings/tokens/new)

2. open the plugin's directory, create a `github_token.txt` file and add the API token

3. restart Wox

### Private Repositories

Simply check the `repo` scope when generating the access token.

### Credits

- [octokit.net](https://github.com/octokit/octokit.net) : A GitHub API client library for .NET

- [expecto](https://github.com/haf/expecto) : testing library

- [humanizer](https://github.com/Humanizr/Humanizer) : Library used to turn date-times into a relative format

- [Github Icon](https://www.iconfinder.com/icons/291716/github_logo_social_social_network_icon) : Icon used