Dashboards from the command line

Create, deploy, and manage dashboards with a powerful CLI built for developers and CI/CD pipelines.

Last updated June 2026 · By Widgets PRO Team

Dashboard Scaffolding

Generate new dashboards from templates with a single command.

Deploy & Publish

Push dashboard changes to production directly from your terminal.

Config as Code

Define dashboards, widgets, and data sources in YAML or JSON configuration files.

CI/CD Integration

Automate deployments with GitHub Actions, GitLab CI, or any pipeline.

Environment Management

Switch between dev, staging, and production environments seamlessly.

API Access

Query and modify dashboards programmatically through the CLI.

Developer workflow

Install the CLI globally, authenticate with your API key, and start managing dashboards from your terminal. Supports shell completions for bash, zsh, and fish.

  • npm install -g @widgets-pro/cli
  • Interactive setup wizard
  • Shell completions
  • JSON and table output formats

Infrastructure as code

Define your entire dashboard setup in version-controlled config files. Review changes in pull requests, deploy with CI/CD, and roll back instantly.

  • YAML/JSON dashboard definitions
  • Git-friendly diff format
  • Dry-run mode for previewing changes
  • Atomic deployments with rollback

Frequently asked questions

  • `npm install -g @widgets/cli` (or via `brew`, `pnpm`, `yarn`). After install, run `widgets login` — opens the browser for OAuth, creates an API key, persists to `~/.widgetsrc`. From then on every command authenticates automatically.

  • `widgets dashboards list/view/create`, `widgets widgets view`, `widgets push`, `widgets pull`, `widgets diff`. Plus convenience: `widgets open` to jump to the web UI. `--json` for machine-readable output, `--open` to launch the browser instead of TUI.

  • `widgets login` opens https://widgets.pro/auth/cli, you sign in, Better Auth creates a scoped API key, and a localhost callback writes it to `~/.widgetsrc`. Manual paste available via `widgets login --manual` for environments without a browser.

  • Yes. Set `WDG_API_KEY` env var (instead of `~/.widgetsrc`) and the CLI authenticates non-interactively. Typical use: `widgets push dashboards/*.yaml` after merge — dashboards become deployable artifacts alongside your code.

Install the CLI

View documentation