GH-ALIAS-IMPORT(1) GitHub CLI manual GH-ALIAS-IMPORT(1)

gh-alias-import - Import aliases from a YAML file

gh alias import [<filename> | -] [flags]

Import aliases from the contents of a YAML file.

Aliases should be defined as a map in YAML, where the keys represent aliases and the values represent the corresponding expansions. An example file should look like the following:

bugs: issue list --label=bug
igrep: '!gh issue list --label="$1" | grep "$2"'
features: |-
    issue list
    --label=enhancement

Use - to read aliases (in YAML format) from standard input.

The output from gh alias list can be used to produce a YAML file containing your aliases, which you can use to import them from one machine to another. Run gh help alias list to learn more.

Overwrite existing aliases of the same name

0: Successful execution

1: Error

2: Command canceled

4: Authentication required

NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information.

# Import aliases from a file
$ gh alias import aliases.yml
# Import aliases from standard input
$ gh alias import -

gh-alias(1)

Jan 2025