83322104b7
* feat: add web flag to cs list subcommand web flag only works with repo flag, because, currently there only param for listing with repo_id * feat: add web flag to cs crate subcommand web flag used for creating codespace through web UI instead of terminal. web flag cannot be used with display-name, idle-timeout, or retention retention-period because there's no option for that in the Web UI * refactor: extract mutual excusive logic to PreRunE - changed web flag mutual exclusive logic, using cmdutil - extract that logic to PreRunE clause in createCmd - move web flag up to make it close to PreRunE clause (for clarity) - add new param to newCreateCmd fn to facilitate test logic - apply new newCreateCmd fn to root.go * fix: clarify flag desc and error message - remove 'yet' from error messages that can cause misunderstanding - clarify list web flag can only be used with repo flag * fix: skip machine check when we use web flag ... (..and no machine flag provided) + add test for this new case + adjust related test cases for this new change. * refactor: move flag check logic to PreRunE why: err on PreRunE or RunE will also print help if error happened + move web, repo, org, user mutual exclusive logic to PreRunE clause + move repo, org, user mutual exclusive logic to PreRunE + move limit check flag to PreRunE + modify newListCmd fn to facilitate test logic + apply new newListCmd to root.go + add test cases to check PreRunE clause - remove mutual exclusive test cases from Test_AppList * refactor: remove the opts equality checks * fix: mutually exclusive misfires because of wrong logic + refine test case too * cleanup:removing useWeb check in fn getMachineName because it's no longer needed + remove redundant test-case * refactor: remove redundant ifs * refactor: clarify test name * re-clarify web flag desc in list.go * refactor: break long lines, use more idiomatic err * add test case for nonexistent/wrong machine |
||
|---|---|---|
| .devcontainer | ||
| .github | ||
| api | ||
| build/windows | ||
| cmd | ||
| context | ||
| docs | ||
| git | ||
| internal | ||
| pkg | ||
| script | ||
| test | ||
| utils | ||
| .gitattributes | ||
| .gitignore | ||
| .golangci.yml | ||
| .goreleaser.yml | ||
| CODEOWNERS | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
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.
GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on 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, 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 |
Linux & BSD
gh is available via:
- our Debian and RPM repositories;
- community-maintained repositories in various Linux distros;
- OS-agnostic package managers such as Homebrew, Conda, and Spack; and
- our releases page as precompiled binaries.
For more information, see Linux & BSD installation.
Windows
gh is available via WinGet, scoop, Chocolatey, Conda, 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 affect. (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.