Close
AlgoliaLogoLight
Close full mode
logo

GitHub CLI secret

Git RepositoryEdit on Github

Requirements

  • Set up GitHub CLI
  • Log in to GitHub with GitHub CLI
  • If you haven't done all requirements, please refer to Set up GitHub CLI document.

Create or update a GitHub secret with CLI

  • To create or update a GitHub secret run:
    gh secret set <SECRET_NAME> \
    --body <SECRET_VALUE> \
    --repo <[HOST/]OWNER/REPO>
  • Example code to create or update a GitHub secret:
    gh secret set AZURE_WEBAPP_NAME \
    --body codesanook-example-app-service \
    --repo codesanook/codesanok-example-app-service
  • Assume that we have a repository name "codesanok-example-app-service" under "codesanook" organization.
  • Example code to create or update a GitHub secret from content of a file:
    gh secret set AZURE_WEBAPP_NAME \
    < secret-value.json \
    --repo codesanook/codesanok-example-app-service
  • To show help of the command, run:
    gh help secret set

List all existing GitHub secrets

  • Command:
    gh secret list --repo <[HOST/]OWNER/REPO>
  • Example code to list all existing GitHub secret a specific repository:
    gh secret list --repo codesanook/codesanok-example-app-service

Remove an existing GitHub secret

  • Command:
    gh secret remove <SECRET_NAME> --repo <[HOST/]OWNER/REPO>
  • Example code to list all existing GitHub secret a specific repository:
    gh secret remove AZURE_WEBAPP_NAME --repo codesanook/codesanok-example-app-service
Loading comments...