Scroll to navigation

GH-SECRET-SET(1) GitHub CLI manual GH-SECRET-SET(1)

NAME

gh-secret-set - Create or update secrets

SYNOPSIS

gh secret set <secret-name> [flags]

DESCRIPTION

Set a value for a secret on one of the following levels: - repository (default): available to GitHub Actions runs or Dependabot in a repository - environment: available to GitHub Actions runs for a deployment environment in a repository - organization: available to GitHub Actions runs, Dependabot, or Codespaces within an organization - user: available to Codespaces for your user

Organization and user secrets can optionally be restricted to only be available to specific repositories.

Secret values are locally encrypted before being sent to GitHub.

OPTIONS

Set the application for a secret: {actions|codespaces|dependabot}

The value for the secret (reads from standard input if not specified)

Set deployment environment secret

Load secret names and values from a dotenv-formatted file

Print the encrypted, base64-encoded value instead of storing it on GitHub

Set organization secret

List of repositories that can access an organization or user secret

Set a secret for your user

Set visibility for an organization secret: {all|private|selected}

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

# Paste secret value for the current repository in an interactive prompt
$ gh secret set MYSECRET
# Read secret value from an environment variable
$ gh secret set MYSECRET --body "$ENV_VALUE"
# Read secret value from a file
$ gh secret set MYSECRET < myfile.txt
# Set secret for a deployment environment in the current repository
$ gh secret set MYSECRET --env myenvironment
# Set organization-level secret visible to both public and private repositories
$ gh secret set MYSECRET --org myOrg --visibility all
# Set organization-level secret visible to specific repositories
$ gh secret set MYSECRET --org myOrg --repos repo1,repo2,repo3
# Set user-level secret for Codespaces
$ gh secret set MYSECRET --user
# Set repository-level secret for Dependabot
$ gh secret set MYSECRET --app dependabot
# Set multiple secrets imported from the ".env" file
$ gh secret set -f .env
# Set multiple secrets from stdin
$ gh secret set -f - < myfile.txt

SEE ALSO

gh-secret(1)

Jun 2024 GitHub CLI v2.51.0