Skip to main content

Get

Command

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

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

Parameters

The following parameters are used to configure the command:

NameDescriptionEnvironment Variables
orgname of organization for the schedulesVELA_ORG, SCHEDULE_ORG
reponame of repository for the schedulesVELA_REPO, SCHEDULE_REPO
outputformat the output for the schedulesVELA_OUTPUT, SCHEDULE_OUTPUT
pageprints a specific page of schedulesVELA_PAGE, SCHEDULE_PAGE
per.pagenumber of schedules to print per pageVELA_PER_PAGE, SCHEDULE_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.

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 schedule

Targeted Request

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

Response

NAME   	ENTRY    	ACTIVE	SCHEDULED_AT    	BRANCH
nightly 0 0 * * * true a long while ago main
hourly 0 * * * * true a long while ago main

Examples

EXAMPLES:
1. Get a list of schedules for a repository.
$ vela get schedule --org MyOrg --repo MyRepo
2. Get a list of schedules for a repository with wide view output.
$ vela get schedule --org MyOrg --repo MyRepo --output wide
3. Get a list of schedules for a repository with yaml output.
$ vela get schedule --org MyOrg --repo MyRepo --output yaml
4. Get a list of schedules for a repository with json output.
$ vela get schedule --org MyOrg --repo MyRepo --output json
5. Get a list of schedules for a repository when config or environment variables are set.
$ vela get schedule