@rawdash/cli
v0.29.2
Published
Rawdash CLI — deploy and manage your dashboard config
Readme
@rawdash/cli
Deploy and manage your rawdash config from the terminal.
What it is
@rawdash/cli is the command-line interface for rawdash. It lets you validate your config locally, deploy it to the rawdash server, and manage secrets — all from your terminal or CI pipeline. It reads your rawdash.config.ts file and communicates with the rawdash API.
Install
npm install -g @rawdash/cli
# or use without installing:
npx @rawdash/cli <command>Requires Node.js 24+.
Quick example
# Validate your config file locally (no network)
npx @rawdash/cli validate
# Preview what would change before deploying
npx @rawdash/cli deploy --dry-run
# Deploy to the server
RAWDASH_API_KEY=your-key npx @rawdash/cli deploy
# Manage secrets
npx @rawdash/cli secrets set GITHUB_TOKEN ghp_...
npx @rawdash/cli secrets list
npx @rawdash/cli secrets remove GITHUB_TOKENCommands
| Command | Description |
| ---------------------------- | -------------------------------------------------------------------------------- |
| validate | Validate rawdash.config.ts locally without network access |
| deploy | Deploy config to the server (use --dry-run to preview, --yes to skip prompt) |
| secrets set <name> [value] | Set a secret (reads from stdin if value is omitted) |
| secrets list | List all secret names and last-rotation timestamps |
| secrets remove <name> | Delete a secret |
Configuration
The CLI expects the following environment variables:
| Variable | Required | Description |
| ----------------- | ------------------------ | ------------------------------------------------ |
| RAWDASH_API_KEY | Yes (for deploy/secrets) | API key for the rawdash server |
| RAWDASH_URL | No | Server base URL (defaults to the hosted service) |
When pointing at the hosted service, RAWDASH_URL must include your org slug,
e.g. https://api.rawdash.dev/<org-slug>. A slug-less base URL is rejected with
a 403, even with a fully-scoped key.
Links
License
Apache-2.0
