version

Documentation

Overview

Package version provides the defined version CLI commands for Vela.

Usage:

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

Index

• Variables

Variables

var CommandVersion = &cli.Command{
	Name:        "version",
	Description: "Use this command to output version information.",
	Usage:       "Output version information",
	Action:      runVersion,
	Flags: []cli.Flag{

		&cli.StringFlag{
			EnvVars: []string{"VELA_OUTPUT", "STEP_OUTPUT"},
			Name:    internal.FlagOutput,
			Aliases: []string{"op"},
			Usage:   "format the output in json, spew, wide or yaml",
		},
	},
	CustomHelpTemplate: fmt.Sprintf(`%s
EXAMPLES:
  1. Output Vela version information
    $ {{.HelpName}} --api.addr https://vela.example.com
  2. Output Vela version information with JSON output
    $ {{.HelpName}} --output json

DOCUMENTATION:

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

CommandVersion defines the command for returning version information on the CLI.