Install the Dash0 CLI in your GitHub Actions workflows. The minimum supported CLI version is 1.1.0.

Quick start

yaml

123456789101112
steps:
  - uses: actions/checkout@v4

  - name: Setup Dash0 CLI
    uses: dash0hq/dash0-cli/.github/actions/setup@main
    with:
      api-url: ... # E.g. https://api.us-west-2.aws.dash0.com
      otlp-url: ... # E.g. https://ingress.us-west-2.aws.dash0.com
      auth-token: ${{ secrets.DASH0_AUTH_TOKEN }}
      dataset: ... # E.g., `production`; if omitted, the `default` dataset is used

  - run: dash0 dashboards list

You can use any git ref: @main, @v1.1.0, or @<commit-sha>.

Inputs

Input	Required	Default	Description
`version`	No	latest	Dash0 CLI version to install (e.g., `1.1.0`). Minimum supported: `1.1.0`.
`cache`	No	`true`	Enable caching of the Dash0 CLI binary
`api-url`	No		Dash0 API URL. Find yours under Endpoints.
`otlp-url`	No		Dash0 OTLP HTTP endpoint URL. Find yours under Endpoints.
`auth-token`	No		Dash0 auth token. Get one from Auth Tokens. Store it in a GitHub secret.
`dataset`	No	`default`	Dash0 dataset name.

All profile inputs (api-url, otlp-url, auth-token, dataset) are optional and can be provided in any combination. When any of them are provided, the action creates a default CLI profile so subsequent dash0 commands use them automatically.

Outputs

Output	Description
`version`	Installed Dash0 CLI version, without the `v` prefix (e.g., `1.1.0`)

Configuration via environment variables

Instead of (or in addition to) action inputs, you can configure the CLI via environment variables in individual steps:

yaml

1234
- name: List dashboards from a different dataset
  env:
    DASH0_DATASET: production
  run: dash0 dashboards list

See the CLI documentation for all supported environment variables.

Supported runners

ubuntu-latest (x64)
ubuntu-24.04-arm (arm64)