Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.gh.enable

Whether to enable GitHub CLI tool.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.gh.package

The gh package to use.

Type: package

Default:

pkgs.gh

Declared by:

programs.gh.extensions

gh extensions, see https://cli.github.com/manual/gh_extension.

Type: list of package

Default:

[ ]

Example:

[ pkgs.gh-eco ]

Declared by:

programs.gh.gitCredentialHelper.enable

Whether to enable the gh git credential helper.

Type: boolean

Default:

true

Example:

true

Declared by:

programs.gh.gitCredentialHelper.hosts

GitHub hosts to enable the gh git credential helper for

Type: list of string

Default:

[
  "https://github.com"
  "https://gist.github.com"
]

Example:

[ "https://github.com" "https://github.example.com" ]

Declared by:

programs.gh.hosts

Host-specific configuration written to $XDG_CONFIG_HOME/gh/hosts.yml.

Type: YAML 1.1 value

Default:

{ }

Example:

{
  "github.com" = {
    user = "<your_username>";
  };
}

Declared by:

programs.gh.settings

Configuration written to $XDG_CONFIG_HOME/gh/config.yml.

Type: open submodule of (YAML 1.1 value)

Default:

{ }

Example:

{
  git_protocol = "ssh";

  prompt = "enabled";

  aliases = {
    co = "pr checkout";
    pv = "pr view";
  };
};

Declared by:

programs.gh.settings.aliases

Aliases that allow you to create nicknames for gh commands.

Type: attribute set of string

Default:

{ }

Example:

{
  co = "pr checkout";
  pv = "pr view";
}

Declared by:

programs.gh.settings.editor

The editor that gh should run when creating issues, pull requests, etc. If blank, will refer to environment.

Type: string

Default:

""

Declared by:

programs.gh.settings.git_protocol

The protocol to use when performing Git operations.

Type: string

Default:

"https"

Example:

"ssh"

Declared by: