1
0
mirror of synced 2026-01-11 21:03:40 -05:00

Expand the GitHub CLI quickstart (#42249)

Co-authored-by: Steve Guntrip <stevecat@github.com>
This commit is contained in:
hubwriter
2023-09-13 12:09:20 +01:00
committed by GitHub
parent 3c1eb8a3b9
commit 997f2f5f7b
4 changed files with 97 additions and 16 deletions

View File

@@ -1,6 +1,6 @@
---
title: GitHub CLI reference
intro: 'You can view all of the {% data variables.product.prodname_cli %} commands in your terminal or in the {% data variables.product.prodname_cli %} manual.'
intro: 'You can view all of the {% data variables.product.prodname_cli %} commands in your terminal. The same information is available in the {% data variables.product.prodname_cli %} manual.'
versions:
fpt: '*'
ghes: '*'
@@ -11,26 +11,34 @@ topics:
type: reference
---
To view all top-level {% data variables.product.prodname_cli %} commands, see the [{% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh) or call `gh` without arguments.
To view all top-level {% data variables.product.prodname_cli %} commands, enter `gh` without arguments.
```shell
gh
```
To list all commands under a specific group, use the top-level command without arguments. For example, to list [commands for managing repositories](https://cli.github.com/manual/gh_repo):
To list all of the subcommands that you can use with a {% data variables.product.prodname_cli %} command, use the top-level command without arguments.
```shell
gh repo
gh COMMAND
```
To view the environment variables that can be used with {% data variables.product.prodname_cli %}, see the [{% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_help_environment) or use the `environment` command.
For example, to view the environment variables that you can set to affect certain aspects of {% data variables.product.prodname_cli %}, use the `environment` command.
```shell
gh environment
```
To view the configuration settings that can be used with {% data variables.product.prodname_cli %}, see the [{% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_config) or use the `config` command.
To view the configuration settings that you can set, use the `config` command.
```shell
gh config
```
To view help for a particular subcommand, use the `--help` flag.
```shell
gh COMMAND [SUBCOMMAND ...] --help
```
All of the information that's available by running these commands in the terminal is also included in the [{% data variables.product.prodname_cli %} online manual](https://cli.github.com/manual/gh).