Skip to content

docs: update dbt-index skill to match current CLI#109

Open
wolfram-s wants to merge 2 commits intomainfrom
wolfram/update-dbt-index-skill-docs
Open

docs: update dbt-index skill to match current CLI#109
wolfram-s wants to merge 2 commits intomainfrom
wolfram/update-dbt-index-skill-docs

Conversation

@wolfram-s
Copy link
Copy Markdown

Summary

  • Rename commands to current primary names: describe (was node), metadata (was query/schema), warehouse (was query-warehouse), metrics (was sl)
  • Add per-command flag reference tables for all 17 subcommands, derived from actual --help output
  • Add missing metrics run flags: --order-by, --where, --time-constraint, --max-rows, --dialect, --profile, --target
  • Add metrics describe --all, metrics list --saved-queries
  • Add lineage --edge-type, describe individual section flags (--sql, --columns, --tests, etc.)
  • Add metadata run --mutate/--attach/--param, warehouse run --mutate
  • Add ingest --target-dir/--auto-hydrate, export --output-dir
  • Add serve flags (--profile, --target, --no-cloud-sync)
  • Add timings subcommands: all, node <name>
  • Add full doctor checks reference (34 checks across error/warn/info + 4 OTel checks)
  • Document --auto-reingest global flag and all output formats

Test plan

  • Every flag/subcommand verified against cargo run -p dbt-index -- <cmd> --help
  • SKILL.md command table matches current primary command names
  • command-reference.md cheat sheet examples use current syntax

🤖 Generated with Claude Code

@wolfram-s wolfram-s requested a review from a team as a code owner April 25, 2026 01:36
- Rename commands to current primary names: describe (was node),
  metadata (was query/schema), warehouse (was query-warehouse),
  metrics (was sl)
- Add per-command flag reference tables for all 17 subcommands,
  derived from actual --help output
- Add missing metrics run flags: --order-by, --where,
  --time-constraint, --max-rows, --dialect, --profile, --target
- Add metrics describe --all, metrics list --saved-queries
- Add lineage --edge-type, describe individual section flags
- Add metadata run --mutate/--attach/--param, warehouse run --mutate
- Add ingest --target-dir/--auto-hydrate, export --output-dir
- Add serve flags (--profile, --target, --no-cloud-sync)
- Add timings subcommands: all, node <name>
- Add full doctor checks reference (34 checks across error/warn/info)
- Document --auto-reingest global flag and all output formats

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@wolfram-s wolfram-s force-pushed the wolfram/update-dbt-index-skill-docs branch from 8d33660 to dd2d41d Compare April 25, 2026 03:35
See [command-reference.md](./references/command-reference.md) for the full command cheat sheet, index schema overview, and global flags.
See [command-reference.md](./references/command-reference.md) for the full flag reference, doctor check list, and index schema.

#### MCP server
Copy link
Copy Markdown
Contributor

@venkaa28 venkaa28 Apr 28, 2026

Choose a reason for hiding this comment

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

why did we delete this?

…cal source

The compact skill rewrite dropped the JSON config snippet for wiring
dbt-index as an MCP server. Restore it and align setup-core.md with
the canonical copy in dbt-index (--auto-reingest is covered in SKILL.md
global flags).

Co-Authored-By: Claude Opus 4.6 <[email protected]>
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.

2 participants