View

Command

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

tip

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

Parameters

The following parameters are used to configure the command:

Name	Description	Environment Variables
id	uuid for the dashboard	VELA_DASHBOARD_ID, DASHBOARD_ID
full	output the repo and build information for the dashboard	VELA_FULL, DASHBOARD_FULL
output	format the output for the dashboard	VELA_OUTPUT, REPO_OUTPUT

tip

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

• 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

$ vela view dashboard --id d3040cd7-9bb6-45d1-a2a1-d794483a902c

Response

{
  Name: Octocat Main Branches,
  ID: d3040cd7-9bb6-45d1-a2a1-d794483a902c,
  Admins: [{
  Active: true,
  Admin: false,
  Dashboards: [],
  Favorites: [],
  ID: 1,
  Name: octokitty,
  Token: ,
}],
  CreatedAt: 1716572402,
  CreatedBy: octokitty,
  UpdatedAt: 1716572402,
  UpdatedBy: octokitty,
  Repos: [{
  Name: octocat/Hello-World,
  ID: 1,
  Branches: [main],
  Events: [],
} {
  Name: octocat/Spoon-Knife,
  ID: 2,
  Branches: [main],
  Events: [],
}],
}

Examples

EXAMPLES:
  1. View a dashboard.
    $ vela view dashboard --id c8da1302-07d6-11ea-882f-4893bca275b8
  2. View a dashboard with repo and build information.
    $ vela view dashboard --id c8da1302-07d6-11ea-882f-4893bca275b8 --full