Help us shape the future of Go! Take the 2026 Go Developer Survey

config

package
v0.28.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 22, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package config provides the defined config CLI commands for Vela.

Usage:

import "github.com/go-vela/cli/command/config"

Index

Constants

This section is empty.

Variables

View Source
var CommandGenerate = &cli.Command{
	Name:        "config",
	Description: "Use this command to generate the config file.",
	Usage:       "Generate the config file used in the CLI",
	Action:      generate,
	Flags: []cli.Flag{

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_ADDR", "CONFIG_ADDR"),
			Name:    internal.FlagAPIAddress,
			Aliases: []string{"a"},
			Usage:   "Vela server address as a fully qualified url (<scheme>://<host>)",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_ACCESS_TOKEN", "CONFIG_ACCESS_TOKEN"),
			Name:    internal.FlagAPIAccessToken,
			Aliases: []string{"at"},
			Usage:   "access token used for communication with the Vela server",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_REFRESH_TOKEN", "CONFIG_REFRESH_TOKEN"),
			Name:    internal.FlagAPIRefreshToken,
			Aliases: []string{"rt"},
			Usage:   "refresh token used for communication with the Vela server",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_TOKEN", "CONFIG_TOKEN"),
			Name:    internal.FlagAPIToken,
			Aliases: []string{"t"},
			Usage:   "token used for communication with the Vela server",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_API_VERSION", "CONFIG_API_VERSION"),
			Name:    internal.FlagAPIVersion,
			Aliases: []string{"av"},
			Usage:   "API version for communication with the Vela server",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_LOG_LEVEL", "CONFIG_LOG_LEVEL"),
			Name:    internal.FlagLogLevel,
			Aliases: []string{"l"},
			Usage:   "set the level of logging - options: (trace|debug|info|warn|error|fatal|panic)",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_OUTPUT", "CONFIG_OUTPUT"),
			Name:    internal.FlagOutput,
			Aliases: []string{"op"},
			Usage:   "format the output in json, spew, or yaml format",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_ORG", "CONFIG_ORG"),
			Name:    internal.FlagOrg,
			Aliases: []string{"o"},
			Usage:   "provide the organization for the CLI",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_REPO", "CONFIG_REPO"),
			Name:    internal.FlagRepo,
			Aliases: []string{"r"},
			Usage:   "provide the repository for the CLI",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_ENGINE", "CONFIG_ENGINE"),
			Name:    internal.FlagSecretEngine,
			Aliases: []string{"e"},
			Usage:   "provide the secret engine for the CLI",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_TYPE", "CONFIG_TYPE"),
			Name:    internal.FlagSecretType,
			Aliases: []string{"ty"},
			Usage:   "provide the secret type for the CLI",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_COMPILER_GITHUB_TOKEN", "COMPILER_GITHUB_TOKEN"),
			Name:    internal.FlagCompilerGitHubToken,
			Aliases: []string{"ct"},
			Usage:   "github compiler token",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_COMPILER_GITHUB_URL", "COMPILER_GITHUB_URL"),
			Name:    internal.FlagCompilerGitHubURL,
			Aliases: []string{"cgu"},
			Usage:   "github url, used by compiler, for pulling registry templates",
		},

		&cli.BoolFlag{
			Hidden: true,
			Name:   "fs.mem-map",
			Usage:  "use memory mapped files for the config file (for testing)",
			Value:  false,
		},
	},
	CustomHelpTemplate: fmt.Sprintf(`%s
EXAMPLES:
  1. Generate the config file with a Vela server address.
    $ {{.FullName}} --api.addr https://vela.example.com
  2. Generate the config file with Vela server token.
    $ {{.FullName}} --api.token fakeToken
  3. Generate the config file with secret engine and type.
    $ {{.FullName}} --secret.engine native --secret.type org
  4. Generate the config file with trace level logging.
    $ {{.FullName}} --log.level trace
  5. Generate the config file when environment variables are set.
    $ {{.FullName}}

DOCUMENTATION:

  https://go-vela.github.io/docs/reference/cli/config/generate/
`, cli.CommandHelpTemplate),
}

CommandGenerate defines the command for producing the config file.

View Source
var CommandRemove = &cli.Command{
	Name:        "config",
	Description: "Use this command to remove one or more fields from the config file.",
	Usage:       "Remove the config file used in the CLI",
	Action:      remove,
	Flags: []cli.Flag{

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_ADDR", "CONFIG_ADDR"),
			Name:    internal.FlagAPIAddress,
			Aliases: []string{"a"},
			Usage:   "removes the API addr from the config file",
			Value:   "false",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_ACCESS_TOKEN", "CONFIG_ACCESS_TOKEN"),
			Name:    internal.FlagAPIAccessToken,
			Aliases: []string{"at"},
			Usage:   "access token used for communication with the Vela server",
			Value:   "false",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_REFRESH_TOKEN", "CONFIG_REFRESH_TOKEN"),
			Name:    internal.FlagAPIRefreshToken,
			Aliases: []string{"rt"},
			Usage:   "refresh token used for communication with the Vela server",
			Value:   "false",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_TOKEN", "CONFIG_TOKEN"),
			Name:    internal.FlagAPIToken,
			Aliases: []string{"t"},
			Usage:   "removes the API token from the config file",
			Value:   "false",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_API_VERSION", "CONFIG_API_VERSION"),
			Name:    internal.FlagAPIVersion,
			Aliases: []string{"av"},
			Usage:   "removes the API version from the config file",
			Value:   "false",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_LOG_LEVEL", "CONFIG_LOG_LEVEL"),
			Name:    internal.FlagLogLevel,
			Aliases: []string{"l"},
			Usage:   "removes the log level from the config file",
			Value:   "false",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_NO_GIT", "CONFIG_NO_GIT", "NO_GIT"),
			Name:    internal.FlagNoGit,
			Aliases: []string{"ng"},
			Usage:   "removes the status of syncing git repo and org with .git/ directory",
			Value:   "false",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_OUTPUT", "CONFIG_OUTPUT"),
			Name:    internal.FlagOutput,
			Aliases: []string{"op"},
			Usage:   "removes the output from the config file",
			Value:   "false",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_ORG", "CONFIG_ORG"),
			Name:    internal.FlagOrg,
			Aliases: []string{"o"},
			Usage:   "removes the org from the config file",
			Value:   "false",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_REPO", "CONFIG_REPO"),
			Name:    internal.FlagRepo,
			Aliases: []string{"r"},
			Usage:   "removes the repo from the config file",
			Value:   "false",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_ENGINE", "CONFIG_ENGINE"),
			Name:    internal.FlagSecretEngine,
			Aliases: []string{"e"},
			Usage:   "removes the secret engine from the config file",
			Value:   "false",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_TYPE", "CONFIG_TYPE"),
			Name:    internal.FlagSecretType,
			Aliases: []string{"ty"},
			Usage:   "removes the secret type from the config file",
			Value:   "false",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_COMPILER_GITHUB_TOKEN", "COMPILER_GITHUB_TOKEN"),
			Name:    internal.FlagCompilerGitHubToken,
			Aliases: []string{"ct"},
			Usage:   "github compiler token",
			Value:   "false",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_COMPILER_GITHUB_URL", "COMPILER_GITHUB_URL"),
			Name:    internal.FlagCompilerGitHubURL,
			Aliases: []string{"cgu"},
			Usage:   "github url, used by compiler, for pulling registry templates",
			Value:   "false",
		},

		&cli.BoolFlag{
			Hidden: true,
			Name:   "fs.mem-map",
			Usage:  "use memory mapped files for the config file (for testing)",
			Value:  false,
		},
	},
	CustomHelpTemplate: fmt.Sprintf(`%s
EXAMPLES:
  1. Remove the config file.
    $ {{.FullName}}
  2. Remove the addr field from the config file.
    $ {{.FullName}} --api.addr true
  3. Remove the token field from the config file.
    $ {{.FullName}} --api.token true
  4. Remove the secret engine and type fields from the config file.
    $ {{.FullName}} --secret.engine true --secret.type true
  5. Remove the log level field from the config file.
    $ {{.FullName}} --log.level true

DOCUMENTATION:

  https://go-vela.github.io/docs/reference/cli/config/remove/
`, cli.CommandHelpTemplate),
}

CommandRemove defines the command for deleting one or more fields from the config file.

View Source
var CommandUpdate = &cli.Command{
	Name:        "config",
	Description: "Use this command to update one or more fields from the config file.",
	Usage:       "Update the config file used in the CLI",
	Action:      update,
	Flags: []cli.Flag{

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_ADDR", "CONFIG_ADDR"),
			Name:    internal.FlagAPIAddress,
			Aliases: []string{"a"},
			Usage:   "update the API addr in the config file",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_ACCESS_TOKEN", "CONFIG_ACCESS_TOKEN"),
			Name:    internal.FlagAPIAccessToken,
			Aliases: []string{"at"},
			Usage:   "access token used for communication with the Vela server",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_REFRESH_TOKEN", "CONFIG_REFRESH_TOKEN"),
			Name:    internal.FlagAPIRefreshToken,
			Aliases: []string{"rt"},
			Usage:   "refresh token used for communication with the Vela server",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_TOKEN", "CONFIG_TOKEN"),
			Name:    internal.FlagAPIToken,
			Aliases: []string{"t"},
			Usage:   "update the API token in the config file",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_API_VERSION", "CONFIG_API_VERSION"),
			Name:    internal.FlagAPIVersion,
			Aliases: []string{"av"},
			Usage:   "update the API version in the config file",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_LOG_LEVEL", "CONFIG_LOG_LEVEL"),
			Name:    internal.FlagLogLevel,
			Aliases: []string{"l"},
			Usage:   "update the log level in the config file",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_NO_GIT", "CONFIG_NO_GIT", "NO_GIT"),
			Name:    internal.FlagNoGit,
			Aliases: []string{"ng"},
			Usage:   "update the status of syncing git repo and org with .git/ directory",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_OUTPUT", "CONFIG_OUTPUT"),
			Name:    internal.FlagOutput,
			Aliases: []string{"op"},
			Usage:   "update the output in the config file",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_ORG", "CONFIG_ORG"),
			Name:    internal.FlagOrg,
			Aliases: []string{"o"},
			Usage:   "update the org in the config file",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_REPO", "CONFIG_REPO"),
			Name:    internal.FlagRepo,
			Aliases: []string{"r"},
			Usage:   "update the repo in the config file",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_ENGINE", "CONFIG_ENGINE"),
			Name:    internal.FlagSecretEngine,
			Aliases: []string{"e"},
			Usage:   "update the secret engine in the config file",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_TYPE", "CONFIG_TYPE"),
			Name:    internal.FlagSecretType,
			Aliases: []string{"ty"},
			Usage:   "update the secret type in the config file",
		},

		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_COMPILER_GITHUB_TOKEN", "COMPILER_GITHUB_TOKEN"),
			Name:    internal.FlagCompilerGitHubToken,
			Aliases: []string{"ct"},
			Usage:   "github compiler token",
		},
		&cli.StringFlag{
			Sources: cli.EnvVars("VELA_COMPILER_GITHUB_URL", "COMPILER_GITHUB_URL"),
			Name:    internal.FlagCompilerGitHubURL,
			Aliases: []string{"cgu"},
			Usage:   "github url, used by compiler, for pulling registry templates",
		},

		&cli.BoolFlag{
			Hidden: true,
			Name:   "fs.mem-map",
			Usage:  "use memory mapped files for the config file (for testing)",
			Value:  false,
		},
	},
	CustomHelpTemplate: fmt.Sprintf(`%s
EXAMPLES:
  1. Update the addr field in the config file.
    $ {{.FullName}} --api.addr https://vela.example.com
  2. Update the token field in the config file.
    $ {{.FullName}} --api.token fakeToken
  3. Update the secret engine and type fields in the config file.
    $ {{.FullName}} --secret.engine native --secret.type org
  4. Update the log level field in the config file.
    $ {{.FullName}} --log.level trace
  5. Update the no git field in the config file.
    $ {{.FullName}} --no-git bool
  6. Update the config file when environment variables are set.
    $ {{.FullName}}

DOCUMENTATION:

  https://go-vela.github.io/docs/reference/cli/config/update/
`, cli.CommandHelpTemplate),
}

CommandUpdate defines the command for modifying one or more fields from the config file.

View Source
var CommandView = &cli.Command{
	Name:        "config",
	Description: "Use this command to view the config file.",
	Usage:       "View the config file used in the CLI",
	Action:      view,
	Flags: []cli.Flag{
		&cli.BoolFlag{
			Hidden: true,
			Name:   "fs.mem-map",
			Usage:  "use memory mapped files for the config file (for testing)",
			Value:  false,
		},
	},
	CustomHelpTemplate: fmt.Sprintf(`%s
EXAMPLES:
  1. View the config file.
    $ {{.FullName}}

DOCUMENTATION:

  https://go-vela.github.io/docs/reference/cli/config/view/
`, cli.CommandHelpTemplate),
}

CommandView defines the command for inspecting the config file.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL