Manual | GitHub CLI Skip to content CLI Copilot CLI Manual Release notes * Getting started * gh * agent-task * create * list * view * alias * delete * import * list * set * api * attestation * download * trusted-root * verify * auth * login * logout * refresh * setup-git * status * switch * token * browse * cache * delete * list * codespace * code * cp * create * delete * edit * jupyter * list * logs * ports * ports forward * ports visibility * rebuild * ssh * stop * view * completion * config * clear-cache * get * list * set * copilot * discussion * comment * create * edit * list * view * extension * browse * create * exec * install * list * remove * search * upgrade * gist * clone * create * delete * edit * list * rename * view * gpg-key * add * delete * list * help * environment * exit-codes * formatting * mintty * reference * telemetry * issue * close * comment * create * delete * develop * edit * list * lock * pin * reopen * status * transfer * unlock * unpin * view * label * clone * create * delete * edit * list * licenses * org * list * pr * checkout * checks * close * comment * create * diff * edit * list * lock * merge * ready * reopen * revert * review * status * unlock * update-branch * view * preview * prompter * project * close * copy * create * delete * edit * field-create * field-delete * field-list * item-add * item-archive * item-create * item-delete * item-edit * item-list * link * list * mark-template * unlink * view * release * create * delete-asset * delete * download * edit * list * upload * verify-asset * verify * view * repo * archive * autolink * autolink create * autolink delete * autolink list * autolink view * clone * create * delete * deploy-key * deploy-key add * deploy-key delete * deploy-key list * edit * fork * gitignore * gitignore list * gitignore view * license * license list * license view * list * read-dir * read-file * rename * set-default * sync * unarchive * view * ruleset * check * list * view * run * cancel * delete * download * list * rerun * view * watch * search * code * commits * issues * prs * repos * secret * delete * list * set * skill * install * list * preview * publish * search * update * ssh-key * add * delete * list * status * variable * delete * get * list * set * workflow * disable * enable * list * run * view CLI manual * Getting started * gh * agent-task * create * list * view * alias * delete * import * list * set * api * attestation * download * trusted-root * verify * auth * login * logout * refresh * setup-git * status * switch * token * browse * cache * delete * list * codespace * code * cp * create * delete * edit * jupyter * list * logs * ports * ports forward * ports visibility * rebuild * ssh * stop * view * completion * config * clear-cache * get * list * set * copilot * discussion * comment * create * edit * list * view * extension * browse * create * exec * install * list * remove * search * upgrade * gist * clone * create * delete * edit * list * rename * view * gpg-key * add * delete * list * help * environment * exit-codes * formatting * mintty * reference * telemetry * issue * close * comment * create * delete * develop * edit * list * lock * pin * reopen * status * transfer * unlock * unpin * view * label * clone * create * delete * edit * list * licenses * org * list * pr * checkout * checks * close * comment * create * diff * edit * list * lock * merge * ready * reopen * revert * review * status * unlock * update-branch * view * preview * prompter * project * close * copy * create * delete * edit * field-create * field-delete * field-list * item-add * item-archive * item-create * item-delete * item-edit * item-list * link * list * mark-template * unlink * view * release * create * delete-asset * delete * download * edit * list * upload * verify-asset * verify * view * repo * archive * autolink * autolink create * autolink delete * autolink list * autolink view * clone * create * delete * deploy-key * deploy-key add * deploy-key delete * deploy-key list * edit * fork * gitignore * gitignore list * gitignore view * license * license list * license view * list * read-dir * read-file * rename * set-default * sync * unarchive * view * ruleset * check * list * view * run * cancel * delete * download * list * rerun * view * watch * search * code * commits * issues * prs * repos * secret * delete * list * set * skill * install * list * preview * publish * search * update * ssh-key * add * delete * list * status * variable * delete * get * list * set * workflow * disable * enable * list * run * view GitHub CLI manual GitHub CLI, or gh , is a command-line interface to GitHub for use in your terminal or your scripts. * Available commands * Usage examples * Community extensions Installation You can find installation instructions on our README . Configuration * Run gh auth login to authenticate with your GitHub account. Alternatively, gh will respect the GITHUB_TOKEN environment variable . * To set your preferred editor, use gh config set editor <editor> . Read more about gh config and environment variables . * Declare your aliases for often-used commands with gh alias set . GitHub Enterprise GitHub CLI supports GitHub Enterprise Server 2.20 and above. To authenticate with a GitHub instance, run: gh auth login --hostname <hostname> To define this host as a default for all GitHub CLI commands, set the GH_HOST environment variable: export GH_HOST=<hostname> Finally, to authenticate commands in scripting mode or automation, set the GH_ENTERPRISE_TOKEN: export GH_ENTERPRISE_TOKEN=<access-token> Support * Ask usage questions and send us feedback in Discussions * Report bugs or search for existing feature requests in our issue tracker Product * Features * Security * Enterprise * Customer stories * Pricing * Resources Platform * Developer API * Partners * GitHub Desktop * GitHub Mobile Support * Help * Community Forum * Expert Services * Status * Contact GitHub Company * About * Blog * Careers * Press * Shop * (c) 2026 GitHub, Inc. * Terms * Privacy * Telemetry * * * * *