Get

Learn how to list schedules.

Command

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

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

Parameters

The following parameters are used to configure the command:

Name	Description	Environment Variables
`org`	name of organization for the schedules	`VELA_ORG`, `SCHEDULE_ORG`
`repo`	name of repository for the schedules	`VELA_REPO`, `SCHEDULE_REPO`
`output`	format the output for the schedules	`VELA_OUTPUT`, `SCHEDULE_OUTPUT`
`page`	prints a specific page of schedules	`VELA_PAGE`, `SCHEDULE_PAGE`
`per.page`	number of schedules to print per page	`VELA_PER_PAGE`, `SCHEDULE_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.

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 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

Last modified June 24, 2024: Update Schedule API response examples (#412) (5fc450e3)