View

Learn how to inspect a step.

Command

$ vela view step <parameters...> <arguments...>

For more information, you can run vela view step --help.

Parameters

The following parameters are used to configure the command:

Name	Description	Environment Variables
`org`	name of organization for the step	`VELA_ORG`, `STEP_ORG`
`repo`	name of repository for the step	`VELA_REPO`, `STEP_REPO`
`build`	number of build for the step	`VELA_BUILD`, `STEP_BUILD`
`step`	number of the step	`VELA_STEP`, `STEP_NUMBER`
`output`	format the output for the step	`VELA_OUTPUT`, `STEP_OUTPUT`

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

org
repo
output

For more information, please review the CLI config documentation.

Permissions

COMING SOON!

Sample

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 view step --build 1 --step 1

Targeted Request

$ vela view step --org github --repo octocat --build 1 --step 1

Response

id: 1
build_id: 1
repo_id: 1
number: 1
name: clone
status: success
error: ""           # Populates when the platform runs into an error with the build
exitcode: 0
created: 1561748980
started: 1561748979
finished: 1561748981
host: "worker.host.com"
runtime: "docker"
distribution: "linux"

Last modified February 9, 2022: chore(CLI): add documentation for CLI repo awareness (#272) (8e9eb4ce)