Skip to content

Commit 67f595c

Browse files
authored
Added dashboard & visualization docs to readme (#50)
1 parent 51164ed commit 67f595c

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Dune CLI
22

3-
A command-line interface for interacting with the [Dune](https://dune.com/) API.
3+
A command-line interface for interacting with the [Dune](https://dune.com/) API — query data, manage visualizations, and build dashboards from your terminal.
44

55
## Installation
66

@@ -57,6 +57,31 @@ Search the Dune dataset catalog.
5757

5858
Categories: `canonical`, `decoded`, `spell`, `community`
5959

60+
### `dune visualization` (alias: `viz`)
61+
62+
Create and manage visualizations on saved queries.
63+
64+
| Command | Description |
65+
|---------|-------------|
66+
| `viz create --query-id <id> --name <name> --options <json> [--type chart\|table\|counter\|...]` | Create a visualization on a saved query |
67+
| `viz get <visualization-id>` | Get a visualization's details and options |
68+
| `viz update <visualization-id> [--name] [--type] [--description] [--options]` | Update an existing visualization |
69+
| `viz delete <visualization-id>` | Permanently delete a visualization |
70+
| `viz list --query-id <id> [--limit] [--offset]` | List all visualizations for a query |
71+
72+
Supported types: `chart`, `table`, `counter`, `pivot`, `cohort`, `funnel`, `choropleth`, `sankey`, `sunburst_sequence`, `word_cloud`.
73+
74+
### `dune dashboard` (alias: `dash`)
75+
76+
Create and manage dashboards.
77+
78+
| Command | Description |
79+
|---------|-------------|
80+
| `dashboard create --name <name> [--visualization-ids 1,2,3] [--text-widgets <json>] [--columns-per-row 1\|2\|3] [--private]` | Create a new dashboard |
81+
| `dashboard get <dashboard-id>` or `dashboard get --owner <handle> --slug <slug>` | Get a dashboard's details and widgets |
82+
| `dashboard update <dashboard-id> [--name] [--slug] [--private] [--tags] [--visualization-widgets <json>] [--text-widgets <json>]` | Update an existing dashboard |
83+
| `dashboard archive <dashboard-id>` | Archive a dashboard |
84+
6085
### `dune docs`
6186

6287
Search and browse Dune documentation. No authentication required.

0 commit comments

Comments
 (0)