Skip to content

docs(skills): currency audit — document auth register & skills list, drop dataset wording#186

Merged
eddietejeda merged 6 commits into
mainfrom
docs/skills-currency-audit
Jun 28, 2026
Merged

docs(skills): currency audit — document auth register & skills list, drop dataset wording#186
eddietejeda merged 6 commits into
mainfrom
docs/skills-currency-audit

Conversation

@eddietejeda

@eddietejeda eddietejeda commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Audited the bundled agent skills against the actual CLI command tree (src/command.rs) and fixed the gaps found. All four skills are version: 0.9.0 (current release).

Changes

  • hotdata/SKILL.md
    • Document hotdata auth register [--email] (existed in the CLI, was undocumented).
    • Clarify that login and register (GitHub and --email) are browser-based PKCE flows: the CLI opens a browser and waits on a local callback; email/password are entered in the browser, not via CLI flags. They require a browser + interactive terminal and do not work under --no-input / headless / CI.
    • Document hotdata skills list (alias for status).
  • hotdata-geospatial/SKILL.md — rephrase "dataset-agnostic" → "data-agnostic". The datasets feature was fully removed in feat(datasets)!: remove datasets commands and dataset feature surface #166; this was the only lingering "dataset" wording in the skills.

Notes

  • Everything else cross-checked clean against the clap command tree (top-level commands, databases/connections/indexes/embedding-providers/context/queries/results/search flags and subcommands).
  • CHANGELOG.md still contains historical datasets entries — deliberately left as-is, since those are a factual release record (including the removal itself).
  • Merged main to resolve a conflict in hotdata/SKILL.md: feat(auth): require explicit login subcommand #182 reworked the same Auth section (bare hotdata auth now prints help instead of logging in). The resolution keeps feat(auth): require explicit login subcommand #182's behavior and layers this PR's auth register docs on top. Skill versions auto-bumped 0.8.1 → 0.9.0 in the merge.

claude[bot]
claude Bot previously approved these changes Jun 25, 2026

@claude claude Bot left a comment

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.

Verified both documented commands against src/command.rs: auth register [--email] (command.rs:269-274) and skills list as an alias for status (command.rs:734-735) both match. No lingering "dataset" wording remains in skills/. Docs accurately reflect the CLI.

- Add 'hotdata auth register [--email]' to core skill Auth section,
  clarifying both variants are browser-based PKCE flows (not headless/--no-input)
- Add 'hotdata skills list' (alias for status) to Agent skills section
- Rephrase 'dataset-agnostic' -> 'data-agnostic' in geospatial skill
  (datasets feature was removed in #166)
claude[bot]
claude Bot previously approved these changes Jun 25, 2026

@claude claude Bot left a comment

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.

Docs-only audit. Verified all claims against the CLI command tree: auth register --email (command.rs:270, auth.rs:395, browser-based PKCE, GitHub default), and skills list as alias for status (command.rs:734). Documentation matches the implementation.

@codecov

codecov Bot commented Jun 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

# Conflicts:
#	skills/hotdata/SKILL.md
Comment thread skills/hotdata/SKILL.md Outdated
claude[bot]
claude Bot previously approved these changes Jun 28, 2026

@claude claude Bot left a comment

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.

Docs-only audit. Verified every claim against the code:

  • auth register + --email flag (command.rs:270-274), defaults to GitHub OAuth (auth.rs:422)
  • both login and register use the run_browser_auth PKCE loopback flow (auth.rs:266-313) — browser-based claim is accurate
  • skills list is an alias for status (command.rs:734-735)

All accurate. One non-blocking super-nit on comment alignment.

Apply review nit — line up the `#` comments for all auth subcommands after
the widest (`register --email`) line.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
claude[bot]
claude Bot previously approved these changes Jun 28, 2026

@claude claude Bot left a comment

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.

Verified the documented commands against src/command.rs: auth register [--email], skills list (alias for status), and the existing login/status/logout all match. Wording fix in the geospatial skill is accurate. Prior alignment super nit is resolved. LGTM.

Audited all four skills against the current command tree and API behavior:

- hotdata/SKILL.md `databases run`: the minted credential is a database API
  token (`source: database_api_token`, not `database_token`), and its scope is
  the enforced create/query/upload allow-list — workspace-level ops 403. Drop
  the fabricated `permissions:["read","write"]` JWT-internals claim.
- hotdata-analytics WORKFLOWS.md: document `query` exit code 3 (incomplete/
  truncated preview — the CLI fails closed), which the exit-code list omitted.

Search and geospatial skills audited clean.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…overy

Optional currency-audit touch-ups:
- hotdata-search: document the `-c` short alias for `--connection-id` on
  `indexes list`/`delete`, and that bm25 indexes accept one or more
  comma-separated columns (vector is the type restricted to exactly one).
- hotdata-geospatial: point table discovery at `databases tables` for tables
  inside a managed database, alongside `tables list` for connection tables.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Comment thread skills/hotdata-analytics/references/WORKFLOWS.md
claude[bot]
claude Bot previously approved these changes Jun 28, 2026

@claude claude Bot left a comment

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.

Documentation changes verified against the CLI source — all accurate (auth register/--email, skills list alias, query exit code 3, database_api_token scope, bm25 multi-column, -c short flags). One non-blocking super nit inline.

Keeps `--help` in sync with the analytics skill: the CLI already exits 3
(EXIT_INCOMPLETE_RESULT) on a truncated/incomplete result via result_exit_code,
including on the status/poll path, but the help text omitted it.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@claude claude Bot left a comment

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.

Verified all factual claims against the source tree: skills list (SkillCommands), auth register --email (AuthCommands::Register), exit code 3 (EXIT_INCOMPLETE_RESULT in query.rs), database_api_token source (databases.rs), and bm25 comma-separated multi-column (indexes.rs:519). Docs match the CLI. Both prior super nits are addressed in this diff.

@eddietejeda eddietejeda merged commit 6d15590 into main Jun 28, 2026
14 checks passed
@eddietejeda eddietejeda deleted the docs/skills-currency-audit branch June 28, 2026 05:19
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