Skip to main content

Get

Command

$ vela get secret <parameters...> <arguments...>
tip

For more information, you can run vela get secret --help.

Parameters

The following parameters are used to configure the command:

NameDescriptionEnvironment Variables
orgname of organization for the secretsVELA_ORG, SECRET_ORG
reponame of repository for the secretsVELA_REPO, SECRET_REPO
secret.enginename of engine that stores the secretsVELA_ENGINE. SECRET_ENGINE
secret.typename of type of secrets being storedVELA_TYPE, SECRET_TYPE
teamname of team for the secrets, or '*' for all teamsVELA_TEAM, SECRET_TEAM
outputformat the output for the secretsVELA_OUTPUT, SECRET_OUTPUT
tip

This command also supports setting the following parameters via a configuration file:

  • secret.engine
  • secret.type
  • org
  • repo
  • output

For more information, please review the CLI config documentation.

Permissions

COMING SOON!

Sample

warning

This section assumes you have already installed and setup the CLI.

To install the CLI, please review the installation documentation.

To setup the CLI, please review the authentication documentation.

Request

$ pwd
~/github/octocat
$ vela get secret --secret.engine native --secret.type repo

Targeted Request

$ vela get secret --secret.engine native --secret.type repo --org github --repo octocat

Response

NAME  ORG             TYPE  EVENTS
foo github/octocat repo push,pull_request