Skip to content

docs: document the cost, health, comments and other panes; require altimate-code 0.12.12 - #46

Open
sahrizvi wants to merge 2 commits into
mainfrom
docs/cli-prereq-0.12.12
Open

sahrizvi wants to merge 2 commits into
mainfrom
docs/cli-prereq-0.12.12

Conversation

@sahrizvi

Copy link
Copy Markdown
Collaborator

What

  • README, new section "Cost, health, comments and more." The scan cost check (/scan-cost, /allow-scan, maxScanBytes), project health (/health, healthBlocksPush, healthConfigPath), team comments (/comments, the two comments settings), /runs, /profile-ctes, /sql-graph, /to-model, /defer and /target, and /propagate. Until now the README named these only in the Settings table and the usage-events paragraph; a reader had no description of what they do, when they run, or what they cost (a warehouse query per CTE, an EXPLAIN that can start a Databricks warehouse, a health check that takes minutes).
  • Prerequisites: altimate-code 0.12.12 or later. 0.12.11 covered column reach only; the tools the features above call (dbt_cost_estimate, dbt_health, dbt_run_results, dbt_cte_profile, dbt_sql_graph, dbt_map_relations, dbt_defer_state, dbt_docs_coverage, docs_share_comments) shipped in 0.12.12.
  • Components: the hooks module and the feature files it loads, which the list left out.
  • CHANGELOG: an Unreleased entry for the above.

Source

Descriptions follow the header comments and command registrations in hooks/features/*.tsx, hooks/lineage.tsx and hooks/dbt-mods.tsx on main, and the 0.12.12 altimate-code CHANGELOG for what each tool runs. No code changes.

Companion PR in altimate-code adds the same features to the "Using with Claude Code" guide and points its install at this marketplace.

🤖 Generated with Claude Code

https://claude.ai/code/session_01XM3J9kD6sRhQQyPAe2BVyn

…timate-code 0.12.12

- README: new "Cost, health, comments and more" section describing the scan
  cost check, project health, team comments, `/runs`, `/profile-ctes`,
  `/sql-graph`, `/to-model`, `/defer` and `/target`, and `/propagate`, which
  the README only named in Settings and Data handling until now
- Prerequisites: altimate-code 0.12.12 or later, the release with the dbt
  Power User tools those features call (0.12.11 only covered column reach)
- Components: the hooks module and the feature files it loads
- CHANGELOG: Unreleased entry for the above

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XM3J9kD6sRhQQyPAe2BVyn
Comment thread plugins/altimate-code/README.md Outdated

## Cost, health, comments and more

The rest of dbt Power User, as panes and commands in the session. They call altimate-code's dbt tools (release 0.12.12 or later) through the plugin's MCP server or `altimate tool run`, and make no model-provider call of their own. The cost check, project health, the SQL graph and CTE timing start the project's dbt adapter, which needs write permission, so they go through the CLI. Each one that cannot work (no altimate-code, or one without its tool) says so where it would have shown its answer.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

SUGGESTION: These features never call the tools over MCP

The opening sentence says they reach the tools "through the plugin's MCP server or altimate tool run", but every call under hooks/features/ passes cliOnly: true or write: true (runs.tsx:438, comments.tsx:458, defer.tsx:317, docs.tsx:488, to-model.tsx:196, cost.tsx:690, sql-graph.tsx:177, health.tsx:531, cte-profile.tsx:161), and runTool forces the CLI in both cases (altimate-cli.ts:206). Unlike the lineage and dbt helpers above, none of this section uses the MCP route; the sentence below about the CLI only covers four of them. Saying they all go through altimate tool run would match the code.

Comment thread plugins/altimate-code/README.md Outdated
The rest of dbt Power User, as panes and commands in the session. They call altimate-code's dbt tools (release 0.12.12 or later) through the plugin's MCP server or `altimate tool run`, and make no model-provider call of their own. The cost check, project health, the SQL graph and CTE timing start the project's dbt adapter, which needs write permission, so they go through the CLI. Each one that cannot work (no altimate-code, or one without its tool) says so where it would have shown its answer.

- **Scan cost check** (`/scan-cost <model>`, `/allow-scan`; setting `maxScanBytes`). Before a `dbt run`, `build` or `show` that Claude runs, the plugin asks `dbt_cost_estimate` what the query would scan: a dry run on BigQuery, the planner's `EXPLAIN` estimate on Snowflake and Databricks. Over the limit (10 GiB by default; 0 never holds) the command is refused with the estimate, in a line above the prompt, until you run `/allow-scan`, which lets that same command through once when it is run again unchanged. Only a command that names its query is estimated: `dbt show --inline <sql>` or a single plain model name (`-s orders`); any other selection, and a command that sets its own target, defer state, vars or project, runs as it is with a line saying so under the Bash row. A query with no estimate (a Databricks table without statistics, an `EXPLAIN` that failed) runs with a line saying why; a warehouse with no estimate is never held after its first answer. Snowflake's number is an upper bound, Databricks' is the tables' size, and on Databricks the `EXPLAIN` can start a stopped SQL warehouse, which is billed while it runs. `/scan-cost <model>` asks for an estimate; with no model it repeats the last one.
- **Project health** (`/health`; settings `healthBlocksPush`, `healthConfigPath`). At session start `dbt_health` (DataPilot) records every insight the project already has. After a turn in which Claude changed model files (`.sql`, `.yml`), the check runs again, and the insights the baseline lacks, on the models those files hold, are the new issues: a band above the prompt lists them, and `/health` shows them in a pane. With `healthBlocksPush` on, `git push` is held until the check of your latest changes is in and refused while any issue remains, or while the check cannot run. One check runs at a time and can take minutes (the dbt adapter starts, then DataPilot reads the manifest); its dbt run writes its artifacts under `target/.altimate-plugin/`, not over the project's `manifest.json`. It needs the `altimate-datapilot-cli` package in the project's Python.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

SUGGESTION: The session-start baseline is conditional

"At session start dbt_health (DataPilot) records every insight the project already has" is stated unconditionally, but the check only runs when the session is interactive or healthBlocksPush is on, and only inside a dbt project (health.tsx:717). Line 56 of this README already notes that; without the condition here, a reader expects a baseline in a non-interactive run, where there is none.

Comment thread plugins/altimate-code/README.md Outdated
- **Defer and target** (`/defer [status|on|off|reset]`, `/target [<name>|reset]`). Reads the dbt Power User defer setting through `dbt_defer_state` and adds `--defer --state <dir>` (and `--favor-state`) to the dbt commands Claude runs that take it (`build`, `run`, `test`, `compile`, `show`, `snapshot`) and do not set it themselves, and `--target <name>` to those without one once you chose a target for the session. `/defer on` and `/defer off` override the setting for the session; `reset` goes back to it. The target shows in the status line, Claude's result says what the command ran as, and a line above the prompt shows the flags added until the next prompt. A command with a word the parser cannot read (`$FLAGS`, `~/x`, a glob) is left as written.
- **Docs coverage and propagation** (`/propagate`). After Claude edits a model's SQL, the model's documentation coverage from `dbt_docs_coverage` (which output columns have no description, and the percent documented) is shown; until the edit's compile-and-validate check has run, it says it is from before the edit. After Claude writes a column description in a model's YAML, the downstream columns that carry the same value (`impact_analysis` column reach; only a column carried as is or renamed, not a calculation from it) are offered as copies: a line under the edit, a band line, and the `/propagate` pane with one **Apply** button per column, which asks Claude to write that description there. Up to three descriptions per edit are traced, and the pane keeps up to ten pending.

Each of these counts its use anonymously when its pane opens (see [Data handling](#data-handling)); none of them runs on its own except the cost check, project health, the comments poll and the coverage line, which the settings above turn off or bound.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

WARNING: "Each of these counts its use" is false for /defer, /target and /propagate

Only scan_cost, comments, profile_ctes, sql_graph, health, runs and to_model send a plugin_feature_used on open (usage.test.tsx:204-214); defer.tsx and docs.tsx never call openTracked/featureUsed, and the /target command has no pane at all. The Data handling paragraph on line 204 likewise omits defer, target and propagate from its plugin_feature_used list, so the cross-reference contradicts it. Three other parts of the sentence are also not true of every bullet: the run recording (runs.tsx:709) and the defer/target flag rewriting both happen on their own, and project health has no setting that turns it off (line 56).

@kilo-code-bot

kilo-code-bot Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

Code Review Summary

Status: 2 Issues Found | Recommendation: Address before merge

Overview

Severity Count
CRITICAL 0
WARNING 0
SUGGESTION 2
Issue Details (click to expand)

SUGGESTION

File Line Issue
plugins/altimate-code/README.md 161 "except dbt runs, which records nothing" has a subject-verb disagreement — dbt runs is plural, so it should be "which record nothing" (or name /runs, the singular feature)
plugins/altimate-code/README.md 164 The session-start dbt_health baseline is still stated unconditionally, but the check only starts in an interactive session or with healthBlocksPush on, inside a dbt project (health.tsx:717); line 173 repeats the same unconditional claim. The added altimate-datapilot-cli prerequisite covers the package, not this condition
Files Reviewed (2 files)
  • plugins/altimate-code/README.md - 2 issues
  • plugins/altimate-code/CHANGELOG.md - no issues

Fix these issues in Kilo Cloud

Previous Review Summary (commit 78b9ad5)

Current summary above is authoritative. Previous snapshots are kept for context only.

Previous review (commit 78b9ad5)

Status: 3 Issues Found | Recommendation: Address before merge

Overview

Severity Count
CRITICAL 0
WARNING 1
SUGGESTION 2
Issue Details (click to expand)

WARNING

File Line Issue
plugins/altimate-code/README.md 173 "Each of these counts its use ... when its pane opens" is false for /defer, /target and /propagate (no plugin_feature_used; Data handling list on line 204 omits them), and the "runs on its own"/"settings turn off or bound" parts don't hold for run recording, defer rewriting or project health

SUGGESTION

File Line Issue
plugins/altimate-code/README.md 161 Says the tools are reached "through the plugin's MCP server or altimate tool run"; every hooks/features/ call uses cliOnly/write, so runTool always takes the CLI route
plugins/altimate-code/README.md 164 Session-start dbt_health baseline is stated unconditionally; it only runs in an interactive session or with healthBlocksPush on, inside a dbt project (health.tsx:717)
Files Reviewed (2 files)
  • plugins/altimate-code/README.md - 3 issues
  • plugins/altimate-code/CHANGELOG.md - no issues

Fix these issues in Kilo Cloud


Reviewed by deepseek-v4.1-flash-1017 · Input: 104.1K · Output: 24.1K · Cached: 1.6M

- Prerequisite is 0.12.11 (the code's `MIN_ALTIMATE_CODE`); the dbt Power
  User features need 0.12.12, and the session-start notice only warns
  below 0.12.11. The text said 0.12.12 for everything.
- The features call tools through `altimate tool run` only, never the
  plugin's MCP server, and pass `--allow-write` without asking.
- On an old CLI dbt runs records nothing and defer adds no flags.
- `/propagate` has tick boxes and one Apply button, not one per column.
- Usage counting now points at the Data handling list instead of
  restating it wrongly; the "runs on its own" sentence names every
  feature that acts without a command and which settings bound them.
- Runs: Claude is told only about overlaps. Comments: Refresh restarts
  the poll after a sign-in. To-model: case-only matches count as matched.
  Snowflake bound: unknown in the cases the answer names. `/target`
  works on any version.
- CHANGELOG entry moved under Added, matching the 1.8.3 README entry.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XM3J9kD6sRhQQyPAe2BVyn

## Cost, health, comments and more

The rest of dbt Power User, as panes and commands in the session. They call altimate-code's dbt tools (release 0.12.12 or later) through `altimate tool run`, never the plugin's MCP server, and make no model-provider call of their own. The cost check, project health, the SQL graph and CTE timing start the project's dbt adapter, which needs write permission, so the plugin runs them with `--allow-write` itself, without asking. One that cannot work (no altimate-code, or one without its tool) says so where it would have shown its answer, except dbt runs, which records nothing, and defer, which adds no flags.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

SUGGESTION: Subject-verb agreement: dbt runs is plural

"except dbt runs, which records nothing" should read "which record nothing" (or "except /runs, which records nothing"). The parallel exception that follows ("defer, which adds no flags") is singular, so this reads as a typo rather than a deliberate reference to the /runs feature.

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