Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
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  reposi-
       tory  -	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:	avail-
       able 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
       -a, --app <string>
	      Set the application for  a  secret:  {actions|codespaces|depend-
	      abot}

       -b, --body <string>
	      The value	for the	secret (reads from standard input if not spec-
	      ified)

       -e, --env <environment>
	      Set deployment environment secret

       -f, --env-file <file>
	      Load secret names	and values from	a dotenv-formatted file

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

       -o, --org <organization>
	      Set organization secret

       -r, --repos <repositories>
	      List of repositories that	can access an organization or user se-
	      cret

       -u, --user
	      Set a secret for your user

       -v, --visibility	<string> (default "private")
	      Set visibility  for  an  organization  secret:  {all|private|se-
	      lected}

OPTIONS	INHERITED FROM PARENT COMMANDS
       -R, --repo <[HOST/]OWNER/REPO>
	      Select another repository	using the [HOST/]OWNER/REPO format

EXIT CODES
       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.

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)

				   Apr 2025		      GH-SECRET-SET(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=gh-secret-set&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help