Skip to content

docs(skill): align SKILL and WORKFLOWS with CLI (flags, sandbox, datasets)#54

Merged
eddietejeda merged 3 commits intomainfrom
docs/skill-cli-align
Apr 24, 2026
Merged

docs(skill): align SKILL and WORKFLOWS with CLI (flags, sandbox, datasets)#54
eddietejeda merged 3 commits intomainfrom
docs/skill-cli-align

Conversation

@eddietejeda
Copy link
Copy Markdown
Contributor

@eddietejeda eddietejeda commented Apr 23, 2026

Summary

Updates the bundled Hotdata agent skill and workflow reference so they match current CLI behavior and common pitfalls.

SKILL.md

  • Use long flags in examples (--workspace-id, --output, --connection-id).
  • Document --output vs nonexistent --format, datasets create --upload-id / --format, workspace lock (HOTDATA_WORKSPACE, sandbox run ancestor), queries without --workspace-id, jobs list pagination, --debug.
  • Sandboxes: sandbox run always creates a new sandbox when no id is given; use direct commands or sandbox <id> run when reusing an active sandbox.
  • Datasets: datasets.<sandbox_id>.<table> vs datasets.main; full_name / FULL NAME; datasets list is unfiltered; sandbox context for queries; PostgreSQL double-quoted identifiers for mixed-case columns.

WORKFLOWS.md

  • New Sandboxes and datasets section (same themes as above).
  • Model refresh, Chain, History, Indexes examples updated; cross-cutting pointers.

PR history

Earlier commits on this branch aligned SKILL output flags and workspace/query notes; this commit adds sandbox/dataset guidance and WORKFLOWS parity.

- 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
@sentry
Copy link
Copy Markdown

sentry Bot commented Apr 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Comment thread skills/hotdata/SKILL.md Outdated
claude[bot]
claude Bot previously approved these changes Apr 23, 2026
- SKILL: document sandbox run vs active sandbox, datasets schema
  (datasets.<sandbox_id> vs main), full_name/FULL NAME, list scope,
  sandbox context for queries, PostgreSQL quoted identifiers
- SKILL: use long CLI flags (--workspace-id, --output, --connection-id)
- WORKFLOWS: new Sandboxes and datasets section; align Chain, Model
  refresh, History, Indexes examples; cross-cutting pointers
@eddietejeda eddietejeda changed the title docs(skill): align Hotdata SKILL with current CLI flags docs(skill): align SKILL and WORKFLOWS with CLI (flags, sandbox, datasets) Apr 23, 2026
claude[bot]
claude Bot previously approved these changes Apr 23, 2026
Comment thread skills/hotdata/SKILL.md
@@ -60,21 +68,21 @@ Full step-by-step procedures: [references/WORKFLOWS.md](references/WORKFLOWS.md)

### List Workspaces
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: This Chain summary bullet still says datasets.main.<table>, but the PR adds content below clarifying the schema is not always main—it can be a sandbox id (e.g. datasets.s_ufmblmvq.tac_csat). Suggest updating to datasets.<schema>.<table> to be consistent with the rest of the PR. (not blocking)

Align the Chain workflow bullet and Querying datasets section on the
qualified name pattern; keep full_name guidance and workspace example.
@eddietejeda eddietejeda merged commit d719c3c into main Apr 24, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant