view release on metacpan or  search on metacpan

share/man/man1/git-hub.1  view on Meta::CPAN

.IX Item "-j, --json"
For some commands, you can get the raw data in \s-1JSON.\s0
.ie n .IP """\-""" 4
.el .IP "\f(CW\-\fR" 4
.IX Item "-"
This option, just a single '\-', is small but very powerful. It means to read the next line from stdin, and put the content into the command at that point. See \s-1PIPE\s0 and \s-1EACH\s0 below.
.ie n .IP """=""" 4
.el .IP "\f(CW=\fR" 4
.IX Item "="
Like the '\-' command above, but reads each \fBword\fR from stdin.
.ie n .IP """\-h""" 4
.el .IP "\f(CW\-h\fR" 4
.IX Item "-h"
Show the brief command usage.
.ie n .IP """\-\-help""" 4
.el .IP "\f(CW\-\-help\fR" 4
.IX Item "--help"
Show the full documentation.
.ie n .IP """\-q"", ""\-\-quiet""" 4
.el .IP "\f(CW\-q\fR, \f(CW\-\-quiet\fR" 4
.IX Item "-q, --quiet"
Show minimal output.
.ie n .IP """\-v"", ""\-\-verbose""" 4
.el .IP "\f(CW\-v\fR, \f(CW\-\-verbose\fR" 4
.IX Item "-v, --verbose"
Show detailed output. Notably, show the raw command that is used for the GitHub \s-1API\s0 calls.
.ie n .IP """\-\-token=<api\-token>""" 4
.el .IP "\f(CW\-\-token=<api\-token>\fR" 4
.IX Item "--token=<api-token>"
Set or override the api-token required by the command. This value can also come from the \f(CW\*(C`GIT_HUB_API_TOKEN\*(C'\fR environment variable. Usually this value comes from your \f(CW\*(C`~/.git\-hub/config\*(C'\fR file.
.ie n .IP """\-d"" ""\-\-dryrun""" 4
.el .IP "\f(CW\-d\fR \f(CW\-\-dryrun\fR" 4
.IX Item "-d --dryrun"
Don't actually make the \s-1API\s0 call. This option turns on verbose mode.
.ie n .IP """\-T""" 4
.el .IP "\f(CW\-T\fR" 4
.IX Item "-T"
Show the \s-1API\s0 token in the verbose output. Hidden by default. This option turns on verbose mode.
.ie n .IP """\-A"", ""\-\-use\-auth""" 4
.el .IP "\f(CW\-A\fR, \f(CW\-\-use\-auth\fR" 4
.IX Item "-A, --use-auth"
Use authentication whether or not it is needed for a certain command.  This is useful if you have exceeded your hourly GitHub \s-1API\s0 rate limit, which is 60 calls unauthenticated, and 5000 calls authenticated.
.ie n .IP """\-C"" ""\-\-no\-cache""" 4
.el .IP "\f(CW\-C\fR \f(CW\-\-no\-cache\fR" 4
.IX Item "-C --no-cache"
There are currently known bugs in GitHub's cache headers. If the content seems stale, use this option.
.SS "Debug Options"
.IX Subsection "Debug Options"
There are a number of debug options that will give you lots of extra information (albeit in a less pretty format).
.ie n .IP """\-O""" 4
.el .IP "\f(CW\-O\fR" 4
.IX Item "-O"
Show the \s-1API\s0 reponse output. Always in \s-1JSON\s0 format. \s-1JSON\s0 is pretty-printed.
.ie n .IP """\-H""" 4
.el .IP "\f(CW\-H\fR" 4
.IX Item "-H"
Show the \s-1API\s0 response headers.
.ie n .IP """\-J""" 4
.el .IP "\f(CW\-J\fR" 4
.IX Item "-J"
Show the \s-1API\s0 response \s-1JSON,\s0 in decoded form.
.ie n .IP """\-R""" 4
.el .IP "\f(CW\-R\fR" 4
.IX Item "-R"
Repeat the last command, using the previous \s-1API\s0 server response. Useful for development and debugging. (Beware, only caches the most recent \s-1API\s0 call, so not really good for commands that make multiple calls).
.ie n .IP """\-x""" 4
.el .IP "\f(CW\-x\fR" 4
.IX Item "-x"
Turn on Bash \f(CW\*(C`\-x\*(C'\fR debugging. This will show every bash command executed in the program. This is extremely useful to track down nasty bugs.
.SH "Arguments"
.IX Header "Arguments"
The \f(CW\*(C`git hub\*(C'\fR command gets its input values from these sources (in this order):
.IP "\(bu" 4
Commandline \fBarguments\fR (see specific command, below).
.IP "\(bu" 4
Environment variables of the form \f(CW\*(C`GIT_HUB_VARIABLE_NAME\*(C'\fR.
.IP "\(bu" 4
The \f(CW\*(C`./.git/config\*(C'\fR file. (The repo you are issuing commands from)
.IP "\(bu" 4
The \f(CW\*(C`~/.githubconfig\*(C'\fR file.
.PP
Most of the commands described below have arguments. This section defines each of the argument types. Note that argument values that are strings containing whitespace need to be quoted.
.PP
Argument variable names are always indicated by angle brackets, like: \f(CW\*(C`<variable>\*(C'\fR. Arguments listed in square brackets are optional and arguments followed by \f(CW\*(C`...\*(C'\fR indicate that more than one is allowed.
.ie n .IP """<user>""" 4
.el .IP "\f(CW<user>\fR" 4
.IX Item "<user>"
A GitHub user name. Sometimes an organization name can be used instead.  If this argument is optional, it defaults to the GitHub owner of the repo you are currently in. If you are not in a GitHub repo, it defaults to your login. \fBOverride\fR: \f(CW...
.ie n .IP """<owner>""" 4
.el .IP "\f(CW<owner>\fR" 4
.IX Item "<owner>"
A GitHub user or organization that owns the repository being specified. This value defaults much like the \f(CW\*(C`<user>\*(C'\fR argument (above). \fBOverride\fR: \f(CW\*(C`GIT_HUB_OWNER_NAME\*(C'\fR environment variable.
.ie n .IP """<org>""" 4
.el .IP "\f(CW<org>\fR" 4
.IX Item "<org>"
A GitHub organization name. \fBOverride\fR: \f(CW\*(C`GIT_HUB_ORG_NAME\*(C'\fR environment variable.
.ie n .IP """<repo>""" 4
.el .IP "\f(CW<repo>\fR" 4
.IX Item "<repo>"
A GitHub repository name. If this argument is optional, it defaults to the GitHub repo name of the repo you are currently in. \fBOverride\fR: \f(CW\*(C`GIT_HUB_REPO_NAME\*(C'\fR environment variable.
.ie n .IP """<owner>/<repo>""" 4
.el .IP "\f(CW<owner>/<repo>\fR" 4
.IX Item "<owner>/<repo>"
Many commands need both an owner and repo separated by a slash. If the owner is you (your GitHub login) you can omit it (but you still need the leading slash). Like \f(CW\*(C`/myrepo\*(C'\fR, instead of \f(CW\*(C`me/myrepo\*(C'\fR. If this argument i...
.ie n .IP """<key\-value\-pair>""" 4
.el .IP "\f(CW<key\-value\-pair>\fR" 4
.IX Item "<key-value-pair>"
Two strings separated by whitespace. Values with embedded whitespace should be quoted. The documentation of each command that needs these pairs, will list the valid keys.
.ie n .IP """<api\-token\-id>""" 4
.el .IP "\f(CW<api\-token\-id>\fR" 4
.IX Item "<api-token-id>"
The integer number \fBid\fR of a token (not the 40 hex-character value).
.ie n .IP """<scope\-name>""" 4
.el .IP "\f(CW<scope\-name>\fR" 4
.IX Item "<scope-name>"
One of the GitHub scopes that you can apply to a token. The \f(CW\*(C`git hub scopes\*(C'\fR command will tell you all of these, and what they mean.
.SH "Commands"
.IX Header "Commands"
These are the commands you can use to perform most of your daily GitHub interactions from the command line. They are installed by default.
.ie n .IP """help""" 4
.el .IP "\f(CWhelp\fR" 4