NAME¶
ghi - command-line interface to the GitHub Issues API
SYNOPSIS¶
ghi command [
arguments] [
options]
DESCRIPTION¶
This manual page documents briefly the
ghi command.
ghi is a command-line interface to the GitHub Issues API. It can be used
to access all of GitHub's documented Issues API (v2) functionality from the
command line: open, close and manipulate issues.
If no command is given, the default action is
list. If a number is given
instead, the default action is
show.
COMMANDS¶
- list [ -s
open|closed|all ]
- Show open, closed or all issues (choose with -s, see
below). Default is open.
- show number
- Show issue number. This command can be invoked also
as ghi <number>.
- open [ number ], o [ number
]
- Create a new issue, and launch $EDITOR. If
number is given, reopens that issue.
- open -m message, o -m
message
- Create a new issue with message content (optionally,
use \n for new lines; first line will be the issue title).
- close number, c number
- Closes issue number.
- edit number, e number
- Edit issue number with $EDITOR.
- label add|remove label
number
- Add or remove label to/from issue number.
You can use al or rl instead of, respectively, label
add and label remove.
- search term, s term
- Search for term.
- comment number, m number
- Create a comment for issue number (with
$EDITOR).
OPTIONS¶
- -h, --help
- Show summary of options.
- -v, --verbose
- Show issue details (only for show, list and search
commands). Default is false.
- -V, --version
- Show program's version number and exit.
- -s STATE, --state=STATE
- Specify state (only for list and search (except
"all") commands). Choices are: open ( o),
closed ( c), all (a). Default is
open.
- -r REPO, --repo=REPO,
--repository= REPO
- Specify a repository. The format:
"user/repo" or just " repo" (latter will
get the user from the global git config).
- -w, --web, --webbrowser
- Show issue(s) GitHub page in web browser (only for list and
show commands). Default is false.
AUTHOR¶
github-cli was written by Sander Smits <jhmsmits@gmail.com>.
This manual page was written by David Paleino <dapal@debian.org>, for the
Debian project (and may be used by others).
