bwrb dashboard

A dashboard is a saved list query. Run dashboards to execute saved queries and manage them with subcommands.

Synopsis

bwrb dashboard [options] [name]
bwrb dashboard <subcommand>

Running Dashboards

Execute a saved dashboard by name:

bwrb dashboard my-tasks
bwrb dashboard inbox --output json   # Override output format

Options

Option	Description
`--output <format>`	Override output format: `text`, `paths`, `tree`, `link`, `json`
`--receipt`	With JSON output, return dashboard identity, its saved definition, the applied query, counts, truncation, and data rows

Subcommands

Subcommand	Description
`list`	List all saved dashboards
`new <name>`	Create a new dashboard
`edit [name]`	Edit an existing dashboard
`delete [name]`	Delete a dashboard

Creating Dashboards

From `bwrb list`

Save any list query as a dashboard:

bwrb list task --where "status='active'" --save-as "active-tasks"
bwrb list task --output tree --save-as "task-tree" --force
bwrb list task --count --save-as "task-count"

Dashboards saved from bwrb list preserve filters, default output settings, selected fields, --sort, --desc, --limit, and --count.

With `dashboard new`

Create a dashboard directly:

bwrb dashboard new my-query --type task --where "status=active"

Examples

# Run a dashboard
bwrb dashboard my-tasks

# Override output format
bwrb dashboard inbox --output json

# List all dashboards
bwrb dashboard list
bwrb dashboard list --output json

# Create a new dashboard
bwrb dashboard new my-query --type task --where "status=active"

# Edit a dashboard
bwrb dashboard edit my-tasks

# Delete a dashboard
bwrb dashboard delete my-tasks --force
bwrb dashboard delete my-tasks -o json --force

Query Receipts

With --receipt and effective JSON output, dashboard output identifies the dashboard name and saved definition alongside the applied query, then reports matched and returned counts, truncated, and rows under data. It is JSON-only, incompatible with --count, and receipt metadata is not persisted when saving a dashboard.