Skip to main content

Get

Command

$ vela get pipeline <parameters...> <arguments...>
tip

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

Parameters

The following parameters are used to configure the command:

NameDescriptionEnvironment Variables
orgname of organization for the pipelinesVELA_ORG, HOOK_ORG
reponame of repository for the pipelinesVELA_REPO, HOOK_REPO
outputformat the output for the pipelinesVELA_OUTPUT, HOOK_OUTPUT
pageprints a specific page of pipelinesVELA_PAGE, HOOK_PAGE
per.pagenumber of pipelines to print per pageVELA_PER_PAGE, HOOK_PER_PAGE
tip

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

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

$ pwd
~/github/octocat
$ vela get pipeline

Targeted Request

$ vela get pipeline --org github --repo octocat

Response

COMMIT                                     REF                 TYPE   VERSION   STAGES   STEPS
a49aaf4afae6431a79239c95247a2b169fd9f067 refs/heads/main yaml 1 f t
48afb5bdc41ad69bf22588491333f7cf71135163 refs/heads/main yaml 1 f t