FAQ

FAQ

• Can I authenticate without a password?

Yes, you may generate a personal access token. Visit github.com/settings/tokens/new to create your token:

Click "Generate Token"

Then configure ghi to use your token.

git config --global ghi.token 036a0402c51c9a3f7de405793d12cffe6ae354d5

• Where does ghi look for issues?

By default, ghi looks for GitHub issues by resolving the current working directory's repository: first it looks for an upstream remote, then it looks at origin.

You can override the repository ghi uses by setting the local ghi.repo git configuration variable:

$ git config ghi.repo username/reponame
$ ghi list
# username/reponame open issues
...

• How do I specify a GitHub enterprise host?

Just run the following inside your terminal and you'll be good to go:

git config github.host address_of_your_enterprise_host

• How do I enable the pretty colored output?

Make sure your terminal is configured to display 256 colors. You can check this by running tput colors, which should return 256.

In case it doesn't you need to set the environmental variable TERM:

export TERM=xterm-256color # or screen-256color

Ideally you'll want to add this to one of your shell configuration files (e.g. ~/.bashrc).

echo "export TERM=xterm-256color" >> ~/.bashrc

If for whatever reason you cannot set the TERM variable globally, it is recommended to set an alias:

alias ghi='TERM=xterm-256color ghi'

This runs ghi with full color support, but leaves the rest of your terminal untouched.

Ubuntu users of a version prior to 12.04, beware! Your terminal will not support 256 colors by default. You need to get an additional library before before setting the TERM variable.

sudo apt-get install ncurses-term

Don't forget to reload your config file (e.g. source ~/.bashrc) or just reopen your terminal.

FreeBSD users will need the package devel/ncurses.

• What about cygwin‽

less can be problematic... you can use less -R.

git config --global ghi.pager "less -X -F -R"

• Can I have syntax highlighting of fenced code blocks?

Yes, you can - if you are using a terminal with 256 colors!

To enable this feature you just need to install the ruby wrapper for pygments:

gem install pygments.rb

Additionally you can specify the used colorset through your gitconfig file(s).

git config --global ghi.highlight.style colorful

Fire up an irb/pry session with the following to see a list of available colorsets:

require 'pygments'
Pygments.styles

• Can I use a custom $EDITOR for ghi?

You can define a custom editor by specifying ghi.editor in your git config (or export $GHI_EDITOR in your environment).

git config --global ghi.editor vim