Get

Learn how to list steps.

Command

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

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

Parameters

The following parameters are used to configure the command:

Name	Description	Environment Variables
`org`	name of organization for the steps	`VELA_ORG`, `STEP_ORG`
`repo`	name of repository for the steps	`VELA_REPO`, `STEP_REPO`
`build`	number of build for the steps	`VELA_BUILD`, `STEP_BUILD`
`output`	format the output for the steps	`VELA_OUTPUT`, `STEP_OUTPUT`
`page`	prints a specific page of steps	`VELA_PAGE`, `STEP_PAGE`
`per.page`	number of steps to print per page	`VELA_PER_PAGE`, `STEP_PER_PAGE`

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

Targeted Request

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

Response

NAME            STATUS  RUNTIME DURATION
publish         failure         1s
build           success         17s
test            success         10s
clone           success         2s

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