gh-repo-deploy-key-add - Man Page

Add a deploy key to a GitHub repository

Synopsis

gh repo deploy-key add <key-file> [flags]

Description

Add a deploy key to a GitHub repository.

Note that any key added by gh will be associated with the current authentication token. If you de-authorize the GitHub CLI app or authentication token from your account, any deploy keys added by GitHub CLI will be removed as well.

Options

-w,  --allow-write

Allow write access for the key

-t,  --title <string>

Title of the new key

Options Inherited from Parent Commands

-R,  --repo <[HOST/]OWNER/REPO>

Select another repository using the [HOST/]OWNER/REPO format

Example

# generate a passwordless SSH key and add it as a deploy key to a repository
$ ssh-keygen -t ed25519 -C "my description" -N "" -f ~/.ssh/gh-test
$ gh repo deploy-key add ~/.ssh/gh-test.pub

See Also

gh-repo-deploy-key(1)

Referenced By

gh-repo-deploy-key(1).

Sep 2022 GitHub CLI manual