Skip to main content

Generate

Command

$ vela generate config <parameters...> <arguments...>
tip

For more information, you can run vela generate config --help.

Parameters

The following parameters are used to configure the command:

NameDescriptionEnvironment Variables
api.addrfull URL to API serverVELA_ADDR, CONFIG_ADDR
api.token.accessAPI access tokenVELA_ACCESS_TOKEN, CONFIG_ACCESS_TOKEN
api.token.refreshAPI refresh tokenVELA_REFRESH_TOKEN, CONFIG_REFRESH_TOKEN
api.tokenPAT for API serverVELA_TOKEN, CONFIG_TOKEN
api.versionversion of API for serverVELA_API_VERSION, CONFIG_API_VERSION
log.levelset the level of loggingVELA_LOG_LEVEL, CONFIG_LOG_LEVEL
no-gitset whether CLI finds repo of cwd automaticallyVELA_NO_GIT, CONFIG_NO_GIT
outputformat the output for API resultsVELA_OUTPUT, CONFIG_OUTPUT
orgname of organization for API callsVELA_ORG, CONFIG_ORG
reponame of repository for API callsVELA_REPO, CONFIG_REPO
secret.enginename of secret engine for API callsVELA_ENGINE, CONFIG_ENGINE
secret.typename of secret type for API callsVELA_TYPE, CONFIG_TYPE

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

vela generate config --api.addr https://vela.example.com --log.level info

Response

api:
addr: https://vela.example.com
log:
level: info
no-git: "false"
secret: {}