You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(skill): align Hotdata SKILL with current CLI flags
- Document -o/--output instead of nonexistent --format
- Add datasets create --upload-id and --format
- Document HOTDATA_WORKSPACE lock, queries without -w, jobs list pagination
- Mention global --debug; clarify workspaces list default marker
Copy file name to clipboardExpand all lines: skills/hotdata/SKILL.md
+26-13Lines changed: 26 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,9 +25,17 @@ API key resolution (lowest to highest priority):
25
25
26
26
API URL defaults to `https://api.hotdata.dev/v1` or overridden via `HOTDATA_API_URL`.
27
27
28
+
Optional: pass **`--debug`** on any command to print verbose HTTP request/response details.
29
+
28
30
## Workspace ID
29
31
30
-
All commands that accept `--workspace-id` are optional. If omitted, the active workspace is used. Use `hotdata workspaces set` to switch the active workspace interactively, or pass a workspace ID directly: `hotdata workspaces set <workspace_id>`. The active workspace is shown with a `*` marker in `hotdata workspaces list`. **Omit `--workspace-id` unless you need to target a specific workspace.**
32
+
Commands that accept `-w` / `--workspace-id` default to the active workspace from config when omitted. Use `hotdata workspaces set` to switch interactively, or `hotdata workspaces set <workspace_id>` for a direct choice. In `hotdata workspaces list`, the `*` marker labels the **default** workspace the CLI resolves to.
33
+
34
+
**`hotdata queries` does not take `-w`:** query run history always uses the active workspace—set it with `workspaces set` first if needed.
35
+
36
+
If **`HOTDATA_WORKSPACE`** is set in the environment, the workspace is **locked** to that value: passing a different `-w` / `--workspace-id` is an error, and **`hotdata workspaces set` fails** (“workspace is locked”). **`workspaces set` is also blocked** while the current process was started under **`hotdata sandbox run`** (nested workspace changes are not allowed in that tree).
37
+
38
+
**Omit `-w` / `--workspace-id` unless you need to target a specific workspace** (and it is not locked by env or session).
31
39
32
40
## Workspace context (API)
33
41
@@ -60,9 +68,9 @@ Full step-by-step procedures: [references/WORKFLOWS.md](references/WORKFLOWS.md)
60
68
61
69
### List Workspaces
62
70
```
63
-
hotdata workspaces list [--format table|json|yaml]
71
+
hotdata workspaces list [-o table|json|yaml]
64
72
```
65
-
Returns workspaces with `public_id`, `name`, `active`, `favorite`, `provision_status`.
73
+
Returns workspaces with `public_id`, `name`, `active`, `favorite`, `provision_status`. Table output marks the default workspace with `*`.
hotdata connections create list [--workspace-id <workspace_id>] [--format table|json|yaml]
94
+
hotdata connections create list [-w <workspace_id>] [-o table|json|yaml]
87
95
```
88
96
Returns all available connection types with `name` and `label`.
89
97
90
98
#### Step 2 — Inspect the schema for a specific type
91
99
```
92
-
hotdata connections create list <name> [--workspace-id <workspace_id>] [--format json]
100
+
hotdata connections create list <name> [-w <workspace_id>] [-o json]
93
101
```
94
-
Returns `config` and `auth` JSON Schema objects describing all required and optional fields for that connection type. Use `--format json` to get the full schema detail.
102
+
Returns `config` and `auth` JSON Schema objects describing all required and optional fields for that connection type. Use **`-o json`** to get the full schema detail.
95
103
96
104
-`config` — connection configuration fields (host, port, database, etc.). May be `null` for services that need no configuration.
97
105
-`auth` — authentication fields (password, token, credentials, etc.). May be `null` for services that need no authentication. May be a `oneOf` with multiple authentication method options.
These commands use the **active workspace only** (there is no `-w` / `--workspace-id` on `queries`); set the default workspace with `workspaces set` if needed.
254
265
-`list` shows query runs with status, creation time, duration, row count, and a truncated SQL preview (default limit 20).
255
266
-`--status` filters by run status (comma-separated, e.g. `--status running,failed`).
256
267
- View a run by ID to see full metadata (timings, `result_id`, snapshot, hashes) and the formatted, syntax-highlighted SQL.
257
268
- If a run has a `result_id`, fetch its rows with `hotdata results <result_id>`.
258
269
270
+
To create a dataset from a **saved query** still registered for the workspace, use **`hotdata datasets create --query-id <saved_query_id>`** (this CLI does not expose separate saved-query create/run subcommands).
0 commit comments