Quickstart

This walkthrough takes you from a freshly installed dash0Copy CLI to running your first commands against a Dash0 environment in about five minutes. It assumes you have already installed the CLI.

1. Log in

Authenticate against your Dash0 environment:

1
dash0 login --profile default --api-url https://api.eu-west-1.aws.dash0.com

Replace the URL with the Dash0 region your organization uses — see the Dash0 API endpoints settings page for the exact URL.

If the defaultCopy profile does not exist yet, the command prompts to create it and marks it as OAuth-authenticated. It then opens your browser, walks through OAuth 2.0 with PKCE, and saves the access token to that profile. Once you have one profile, subsequent dash0 loginCopy calls without --profileCopy refresh the active profile.

If you cannot use an interactive login (for example in a CI runner or an AI agent session), set DASH0_AUTH_TOKENCopy to a static auth_*Copy token instead — see the loginCopy reference for the full authentication story.

2. Confirm the active profile

1
dash0 config show

The output shows the resolved API URL, OTLP URL, dataset, and auth-token metadata for the profile the CLI will use.

3. List some assets

Try listing the dashboards you can see:

1
dash0 dashboards list

The same pattern works for every other asset type — viewsCopy, check-rulesCopy, synthetic-checksCopy, recording-rulesCopy, notification-channelsCopy, spam-filtersCopy.

For structured output (useful in scripts and agent workflows):

1
dash0 dashboards list -o json

4. Query telemetry

Run a query for the most recent logs:

1
dash0 logs query --from now-15m

Narrow to a specific service:

1
dash0 logs query --from now-15m --filter "service.name is my-service"

The same time-range, filter, and column flags apply to dash0 spans queryCopy, dash0 metrics instantCopy, and dash0 failed-checks queryCopy.

5. Send a deployment event

Emit a log event announcing that a deployment happened:

123456
dash0 logs send "Deployment v1.0 completed" \
    --event-name dash0.deployment \
    --severity-number 9 \
    --resource-attribute service.name=my-service \
    --resource-attribute deployment.environment.name=production \
    --log-attribute deployment.status=succeeded

The event surfaces in the Dash0 UI's deployment stream and can be correlated with the traces and logs that follow it.

Where to next

• Command Reference — full syntax and examples for every command.
• GitHub Actions — run the CLI from CI/CD workflows.