Skip to content

Latest commit

 

History

History
91 lines (58 loc) · 2.57 KB

noseyparker-github.1.md

File metadata and controls

91 lines (58 loc) · 2.57 KB

NAME

noseyparker-github - Interact with GitHub

SYNOPSIS

noseyparker github [--github-api-url] [-v|--verbose]... [-q|--quiet] [--color] [--progress] [--rlimit-nofile] [--sqlite-cache-size] [--enable-backtraces] [-h|--help] <subcommands>

DESCRIPTION

Interact with GitHub

By default, unauthenticated access is used. An optional personal access token can be specified using the `NP_GITHUB_TOKEN` environment variable. Using a personal access token gives higher rate limits and may make additional content accessible.

OPTIONS

--github-api-url=URL [default: https://api.github.com/\]
Use the specified URL for GitHub API access

If accessing a GitHub Enterprise Server instance, this value should be the entire base URL include the `api/v3` portion, e.g., `https://github.example.com/api/v3\`.

-v, --verbose
Enable verbose output

This can be repeated up to 3 times to enable successively more output.

-q, --quiet
Suppress non-error feedback messages

This silences WARNING, INFO, DEBUG, and TRACE messages and disables progress bars. This overrides any provided verbosity and progress reporting options.

--color=MODE [default: auto]
Enable or disable colored output

When this is "auto", colors are enabled for stdout and stderr when they are terminals.

If the `NO_COLOR` environment variable is set, it takes precedence and is equivalent to `--color=never`.

[possible values: auto, never, always]

--progress=MODE [default: auto]
Enable or disable progress bars

When this is "auto", progress bars are enabled when stderr is a terminal.

[possible values: auto, never, always]

--rlimit-nofile=LIMIT [default: 16384]
Set the rlimit for number of open files to LIMIT

This should not need to be changed from the default unless you run into crashes from running out of file descriptors.

--sqlite-cache-size=SIZE [default: -1048576]
Set the cache size for sqlite connections to SIZE

This has the effect of setting SQLites `pragma cache_size=SIZE`. The default value is set to use a maximum of 1GiB for database cache. See <https://sqlite.org/pragma.html#pragma_cache_size\> for more details.

--enable-backtraces=BOOL [default: true]
Enable or disable backtraces on panic

This has the effect of setting the `RUST_BACKTRACE` environment variable to 1.

[possible values: true, false]

-h, --help
Print help (see a summary with -h)

SUBCOMMANDS

noseyparker-github-repos(1)
Interact with GitHub repositories