1
0
Fork
You've already forked cli
0
No description
  • Go 99.7%
  • Shell 0.2%
William Martin 1953a9e0f7
Merge pull request #8607 from Xeonacid/patch-1
Update Arch repo to [extra]
2024年01月23日 18:00:32 +01:00
.devcontainer Align devcontainer Go version with go.mod ( #8570 ) 2024年01月12日 13:58:56 -08:00
.github build(deps): bump actions/cache from 3 to 4 ( #8594 ) 2024年01月18日 07:37:49 -08:00
api Rename authCfg.Token to authCfg.ActiveToken and authCfg.SetToken to authCfg.SetActiveToken 2023年12月06日 14:06:28 +01:00
build/windows New deployment workflow 2023年05月09日 20:23:54 +02:00
cmd Remove redundant error on migration failure 2023年12月11日 16:25:20 +01:00
context gh pr create duplicates targets if there are duplicate remotes ( #8184 ) 2023年10月17日 08:21:35 +00:00
docs Update Arch repo to [extra] 2024年01月22日 20:52:25 +08:00
git Simplify git AddRemote to remove unused arg ( #8392 ) 2023年12月04日 15:48:08 -04:00
internal Fix some typos raised by codespell 2024年01月17日 15:34:49 +01:00
pkg added URL for newly created repo ( #8574 ) 2024年01月19日 12:16:15 +01:00
script Fix some typos raised by codespell 2024年01月17日 15:34:49 +01:00
test Pass web browser to each individual command 2021年03月19日 21:22:37 +01:00
utils Add headers to all tables ( #8157 ) 2023年10月20日 11:20:02 +02:00
.gitattributes Retire copy-release-to-another-repo action 2020年01月29日 16:13:07 +01:00
.gitignore New deployment workflow 2023年05月09日 20:23:54 +02:00
.golangci.yml Re-enable linters now that golangci-lint has been updated ( #5615 ) 2022年05月11日 16:57:57 +02:00
.goreleaser.yml Update deployment workflow for final HSM solution 2023年12月14日 13:15:38 -05:00
go.mod build(deps): bump golang.org/x/crypto from 0.14.0 to 0.17.0 ( #8473 ) 2024年01月02日 11:44:29 -08:00
go.sum build(deps): bump golang.org/x/crypto from 0.14.0 to 0.17.0 ( #8473 ) 2024年01月02日 11:44:29 -08:00
LICENSE Create LICENSE 2019年11月21日 13:22:23 -06:00
Makefile Make: Fix target name for Windows platform ( #7370 ) 2023年05月09日 20:23:54 +02:00
README.md Add Webi as an option for installation ( #8555 ) 2024年01月15日 13:05:06 +01:00

GitHub CLI

gh is GitHub on the command line. It brings pull requests, issues, and other GitHub concepts to the terminal next to where you are already working with git and your code.

screenshot of gh pr status

GitHub CLI is supported for users on GitHub.com and GitHub Enterprise Server 2.20+ with support for macOS, Windows, and Linux.

Documentation

For installation options see below, for usage instructions see the manual.

Contributing

If anything feels off, or if you feel that some functionality is missing, please check out the contributing page. There you will find instructions for sharing your feedback, building the tool locally, and submitting pull requests to the project.

If you are a hubber and are interested in shipping new commands for the CLI, check out our doc on internal contributions.

Installation

macOS

gh is available via Homebrew, MacPorts, Conda, Spack, Webi, and as a downloadable binary from the releases page.

Homebrew

Install: Upgrade:
brew install gh brew upgrade gh

MacPorts

Install: Upgrade:
sudo port install gh sudo port selfupdate && sudo port upgrade gh

Conda

Install: Upgrade:
conda install gh --channel conda-forge conda update gh --channel conda-forge

Additional Conda installation options available on the gh-feedstock page.

Spack

Install: Upgrade:
spack install gh spack uninstall gh && spack install gh

Webi

Install: Upgrade:
curl -sS https://webi.sh/gh | sh webi gh@stable

For more information about the Webi installer see its homepage.

Linux & BSD

gh is available via:

For more information, see Linux & BSD installation.

Windows

gh is available via WinGet, scoop, Chocolatey, Conda, Webi, and as downloadable MSI.

WinGet

Install: Upgrade:
winget install --id GitHub.cli winget upgrade --id GitHub.cli

Note


The Windows installer modifies your PATH. When using Windows Terminal, you will need to open a new window for the changes to take effect. (Simply opening a new tab will not be sufficient.)

scoop

Install: Upgrade:
scoop install gh scoop update gh

Chocolatey

Install: Upgrade:
choco install gh choco upgrade gh

Signed MSI

MSI installers are available for download on the releases page.

Codespaces

To add GitHub CLI to your codespace, add the following to your devcontainer file:

"features": {
 "ghcr.io/devcontainers/features/github-cli:1": {}
}

GitHub Actions

GitHub CLI comes pre-installed in all GitHub-Hosted Runners.

Other platforms

Download packaged binaries from the releases page.

Build from source

See here on how to build GitHub CLI from source.

Comparison with hub

For many years, hub was the unofficial GitHub CLI tool. gh is a new project that helps us explore what an official GitHub CLI tool can look like with a fundamentally different design. While both tools bring GitHub to the terminal, hub behaves as a proxy to git, and gh is a standalone tool. Check out our more detailed explanation to learn more.