https://github.com/caseywebb/ghmenu
GitHub dmenu Launcher
https://github.com/caseywebb/ghmenu
dmenu dmenu-github dmenu-scripts dwm github i3 i3-config i3bar i3wm
Last synced: about 2 months ago
JSON representation
GitHub dmenu Launcher
- Host: GitHub
- URL: https://github.com/caseywebb/ghmenu
- Owner: caseyWebb
- License: wtfpl
- Created: 2018-12-14T21:58:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T11:56:59.000Z (about 2 years ago)
- Last Synced: 2024-10-18T07:13:25.707Z (7 months ago)
- Topics: dmenu, dmenu-github, dmenu-scripts, dwm, github, i3, i3-config, i3bar, i3wm
- Language: JavaScript
- Size: 1.35 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ghmenu
> Navigate to a GitHub repo, issue, or pull request via [dmenu][]
![recording][]
# Installation
This package is published via [npm][] and requires [Node >=10](https://nodejs.org)
Install globally with your node package manager of choice
_e.g._
```
$ npm install -g ghmenu
$ yarn global add ghmenu
```
# Usage
ghmenu requires a [GitHub personal access token](https://github.com/settings/tokens) with `repo` access to be stored via [pass][] as `tokens/github/repo`. This prevents the need to keep it hanging around on your machine as an environment variable, or otherwise insecurely stored.
If you've never used pass before, install and initialize it first as described in [here][pass], then generate your token, and store it as such...
```bash
$ pass insert tokens/github/repo
```
Now you may call `ghmenu` from the terminal, although you probably want to bind it to a hotkey. Using i3, you may add the following line to your `~/.config/i3/config` file...
```
bindsym $mod+g exec --no-startup-id ghmenu
```
# Troubleshooting
- Make sure you have Node >=10 installed and available from the environment that ghmenu is being invoked from. If you use `n`, `nvm`, or some other Node version manager, the `node` bin _may not exist_ outside of your shell
- Ensure your node package manager's global bin directory has been added to the PATH. You may wish to use `$(npm bin -g)/ghmenu` or `$(yarn global bin)/ghmenu` in your i3 (or wherever) config
[recording]: ./recording.gif
[dmenu]: https://wiki.archlinux.org/index.php/Dmenu
[pass]: https://wiki.archlinux.org/index.php/Pass
[npm]: https://npmjs.org