redash-cli
A small command-line client for Redash.
This tool manages local Redash profiles, stores API keys in macOS Keychain, and runs ad-hoc SQL through the Redash API.
Requirements
- Node.js 20 or newer
- pnpm 10.33.0 or newer for local development
- macOS Keychain access for storing Redash API keys
- A Redash API key
Installation
Install the published npm package globally:
npm install --global @urugus/redash-cli
redash --help
Or install it globally with pnpm:
pnpm add --global @urugus/redash-cli
redash --help
For local development, install dependencies and build the CLI:
pnpm install
pnpm build
Run the built CLI directly:
node dist/index.js --help
Optionally link it as a global redash command:
pnpm link --global
redash --help
Configuration
Create or update a Redash profile:
redash config set --profile default --url https://redash.example.com
The command prompts for a Redash API key. Profile metadata is saved to:
~/.config/redash-cli/config.json
API keys are stored separately in macOS Keychain under the redash-cli service.
List configured profiles:
redash config list
Set the default profile:
redash config use default
Commands
Test authentication for the default profile:
redash auth test
Test authentication for a specific profile:
redash auth test --profile staging
List Redash data sources:
redash data-sources list
List Redash dashboards:
redash dashboards list
List Redash dashboards with explicit paging and sort order:
redash dashboards list --page 1 --page-size 20 --order=-created_at
Get a Redash dashboard by slug:
redash dashboards get sales-overview
Invite a Redash user:
redash users invite --name "Taro Yamada" --email [email protected]
Create a pending invitation without sending email:
redash users invite --name "Taro Yamada" --email [email protected] --no-send-email
Show Redash query queue and worker status:
redash admin queue-status
Admin commands require a super admin API key.
Run SQL and print JSON:
redash query run --data-source-id 1 --sql "select 1 as value"
Run SQL and print CSV:
redash query run --data-source-id 1 --sql "select 1 as value" --format csv
Use a non-default profile:
redash query run --profile staging --data-source-id 1 --sql "select current_date"
Preview a PostgreSQL query plan without running the query:
redash query explain --data-source-id 1 --sql "select * from invoices"
query explain currently supports PostgreSQL data sources only. It runs
EXPLAIN (FORMAT JSON) without ANALYZE, accepts only single SELECT or WITH
queries, and prints a JSON object containing a small summary plus the raw plan.
Development
pnpm test
pnpm lint
pnpm check
pnpm format
Build output is written to dist/.
Agent Plugins
This repository includes shareable plugins for Codex and Claude Code. Both plugins package the same
redash-cli skills:
redash-cli-dev: repository development, tests, package metadata, and release preparation.redash-cli-setup: first-time setup from source or from the published npm package.redash-cli-usage: day-to-day use of the installed redash command.
The skills live under:
plugins/redash-cli/skills/
They are packaged as plugins instead of standalone project skills so other users can install only
these redash-cli workflows from a marketplace.
Codex
Codex uses:
- Plugin manifest:
plugins/redash-cli/.codex-plugin/plugin.json
- Marketplace manifest:
.agents/plugins/marketplace.json
Install the marketplace and plugin:
codex plugin marketplace add urugus/redash-cli
codex plugin add redash-cli@redash-cli
Start a new Codex thread after installing so Codex can discover the plugin skills.
Claude Code
Claude Code uses:
- Plugin manifest:
plugins/redash-cli/.claude-plugin/plugin.json
- Marketplace manifest:
.claude-plugin/marketplace.json
Install the marketplace and plugin:
claude plugin marketplace add urugus/redash-cli
claude plugin install redash-cli@redash-cli
Plugin skills are namespaced in Claude Code:
/redash-cli:redash-cli-usage
/redash-cli:redash-cli-setup
/redash-cli:redash-cli-dev
For local Claude Code plugin development, load the plugin directly:
claude --plugin-dir ./plugins/redash-cli
Validate the Claude Code marketplace and plugin:
claude plugin validate .
claude plugin validate ./plugins/redash-cli --strict
Release
This package uses npm versions and Git tags as a pair:
package.json version 0.1.2 <=> Git tag v0.1.2 <=> npm package @urugus/[email protected]
Before creating a release, verify the package:
pnpm release:check
