Repository navigation
docs: install the Claude Code plugin from Altimate's marketplace, and document its panes #1809
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -86,27 +86,23 @@ altimate: | |||||
|
|
||||||
| ### The Altimate Code plugin (recommended) | ||||||
|
|
||||||
| 1. Install Altimate Code (Node.js 20 or later): `npm install -g altimate-code` | ||||||
| 2. Install the plugin from Anthropic's plugin directory: | ||||||
|
|
||||||
| ```bash | ||||||
| claude plugin install altimate-code | ||||||
| ``` | ||||||
|
|
||||||
| Or add Altimate's own marketplace and install from it: | ||||||
| 1. Install Altimate Code (Node.js 20 or later): `npm install -g altimate-code`. The plugin needs version 0.12.11 or later, and the commands under [Lineage, cost, health and more](#lineage-cost-health-and-more) need 0.12.12; `altimate-code --version` shows what you have. | ||||||
| 2. Add Altimate's marketplace and install the plugin from it: | ||||||
|
|
||||||
| ```bash | ||||||
| claude plugin marketplace add AltimateAI/altimate-claude-plugin | ||||||
| claude plugin install altimate-code@altimate-claude-plugin | ||||||
| ``` | ||||||
|
|
||||||
| Anthropic's plugin directory also lists the plugin (`claude plugin install altimate-code` with no marketplace), but it serves a reviewed, pinned copy that is several versions behind: it hands tasks to Altimate Code and has none of the panes and helpers below. If you installed that copy, remove it first (see [dbt helpers beside the chat](#dbt-helpers-beside-the-chat)). | ||||||
|
|
||||||
| 3. Start a new Claude Code session in your project. Ask for dbt or warehouse work as usual, or start a request with `/altimate-code:altimate` to hand it over yourself. (Claude Code names plugin commands `<plugin>:<command>`; the bare `/altimate` below comes from `/configure-claude`.) | ||||||
|
|
||||||
| The plugin runs `altimate-code run` in your project for each task, with the model provider Altimate Code is set up with. If you have not set one up, run `altimate-code` once and choose a provider, or sign in to Altimate (below). | ||||||
|
|
||||||
| #### dbt helpers beside the chat | ||||||
|
|
||||||
| Plugin 1.8.0 or later brings five dbt Power User helpers into the Claude Code session when you work in a dbt project. They are on by default; to turn them off, set the plugin's `dbt_mods` option to false in `/config`. Anthropic's plugin directory serves a reviewed, pinned version of the plugin that does not yet include these helpers, so `claude plugin update altimate-code` will not bring them. Install from Altimate's marketplace instead, remove the other copy, then start a new session. Run `claude plugin list` to see which copy you have: the directory's copy is `altimate-code@anthropic-plugin-directory` (or `altimate-code@claude-plugins-official` when you added Anthropic's catalog from GitHub), and the uninstall below names it. | ||||||
| Plugin 1.8.0 or later brings five dbt Power User helpers into the Claude Code session when you work in a dbt project; they run the project's own dbt. The plugin also has a lineage pane and more dbt Power User commands that call Altimate Code's dbt tools instead (see [Lineage, cost, health and more](#lineage-cost-health-and-more)). The five helpers are on by default; to turn them off, set the plugin's `dbt_mods` option to false in `/config`. Anthropic's plugin directory serves a reviewed, pinned version of the plugin that does not yet include these helpers, so `claude plugin update altimate-code` will not bring them. Install from Altimate's marketplace instead, remove the other copy, then start a new session. Run `claude plugin list` to see which copy you have: the directory's copy is `altimate-code@anthropic-plugin-directory` (or `altimate-code@claude-plugins-official` when you added Anthropic's catalog from GitHub), and the uninstall below names it. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. SUGGESTION: The pinned-directory caveat is still stated twice on this page. Step 2 above (line 97) already says Anthropic's directory serves a reviewed, pinned copy that is behind and has none of the panes and helpers. This paragraph repeats the same explanation (pinned, no helpers, |
||||||
|
|
||||||
| ```bash | ||||||
| claude plugin uninstall altimate-code@anthropic-plugin-directory # or the ID `claude plugin list` shows | ||||||
|
|
@@ -144,6 +140,23 @@ Compile and validate runs one query on your warehouse after each model edit (a ` | |||||
|
|
||||||
| The helpers read `manifest.json` and `run_results.json` from the `target-path` that `dbt_project.yml` names (`target/` by default). A path set by `DBT_TARGET_PATH`, a command's `--target-path` or a Jinja `target-path` is not followed. | ||||||
|
|
||||||
| #### Lineage, cost, health and more | ||||||
|
|
||||||
| The rest of the plugin's panes and commands call Altimate Code's tools through `altimate tool run`, and make no model-provider call of their own. The dbt Power User ones need altimate-code 0.12.12 or later, the release with the [dbt Power User tools](../tools/dbt-tools.md#dbt-power-user-tools); with an older one most say so where their answer would be, while `/runs` records nothing and `/defer` adds no flags. Cost, health, the SQL graph and CTE timing start the project's dbt adapter, so the plugin runs them with `altimate tool run --allow-write` itself, without asking. The commands are listed by the bare names the plugin registers. | ||||||
|
|
||||||
| - **Lineage pane** (`/lineage <model>[.column]`). The dbt model Claude reads or edits, with every model upstream and downstream, its exposures (dashboards and other consumers), each output column's sources and, for a picked column, the downstream models and dashboards that read it, from `dbt_lineage` and `impact_analysis` on `target/manifest.json`. When a task changed a model, a band above the prompt sums up each changed column's downstream reach, and **Open report** or `/lineage-report` builds an offline HTML report of it. Claude Code opens the pane on its own only in a terminal at least 144 columns wide; `/lineage` opens it at any width. | ||||||
| - **Scan cost check** (`/scan-cost <model>`, `/allow-scan`). Before a `dbt run`, `build` or `show` that Claude runs names one model or an inline query, `dbt_cost_estimate` says what it would scan: a BigQuery dry run, or the planner's `EXPLAIN` on Snowflake and Databricks. Over the plugin's `maxScanBytes` setting (10 GiB by default; 0 never holds) the command is refused with the estimate until you run `/allow-scan`, which lets that same command through once. A query with no estimate runs, with a line saying why, and other warehouses are never held. On Databricks the `EXPLAIN` can start a stopped SQL warehouse, which is billed while it runs. | ||||||
| - **Project health** (`/health`). At session start `dbt_health` (DataPilot) records the project's existing insights; after a turn in which Claude changed model files, the check runs again and the new issues on those models show in a band. With `healthBlocksPush` on, `git push` is refused while the check of your latest changes is not in or finds new issues. `healthConfigPath` names a DataPilot config file by a path inside the dbt project. A check can take minutes, and it needs the `altimate-datapilot-cli` package in the project's Python. | ||||||
| - **Team comments** (`/comments`). The open comment threads on dbt docs your team shared through Altimate, fetched at session start and, in an interactive session, every `commentsPollSeconds` (15 minutes by default). When Claude reads or edits a model that has open threads, they are added to its context as quoted data (`commentsInContext`), so it sees the review before it changes the model. Reply and resolve are buttons you press in the pane; Claude has no way to post. Needs an Altimate sign-in. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Qualify the promise that Claude sees comments before editing. If the initial comments fetch takes more than three seconds, the first read can return without the threads. Claude can then edit before the fetch finishes. State that comments are added when available, rather than guaranteeing they are seen before an edit. (raw.githubusercontent.com)
|
||||||
| - **dbt runs** (`/runs`). The dbt commands Claude ran that wrote `run_results.json`, with their per-node results from `dbt_run_results`, up to 50 runs per project, kept on this machine across sessions. From the pane a run can be opened, run again, or its failures run again through the prompt. | ||||||
| - **Profile CTEs** (`/profile-ctes [model]`). Times each CTE of a model with one `COUNT(*)` warehouse query per CTE (`dbt_cte_profile`), slowest first, in a pane that fills as the queries finish. It runs only when asked, never on an edit, since every CTE is a warehouse query. Without a model it profiles the model last read or edited. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. P3: This omits that (Based on your team's feedback about CTE wall timing.) [93c2f203-0e67-4730-acb2-c2d60132c7e1] Prompt for AI agents
Suggested change
|
||||||
| - **SQL graph** (`/sql-graph [model]`). A model's CTEs, joins and filters as a graph beside the chat (`dbt_sql_graph`). It compiles the model and reads the parents' column metadata from the warehouse. | ||||||
| - **Raw SQL to a dbt model** (`/to-model <name> [path/to/query.sql]`). `dbt_map_relations` maps each table in the SQL (a file, or the text you selected) to a `ref()` or `source()` call; the pane lists the tables that need a decision first, and then asks Claude to write the model with exactly those replacements. | ||||||
| - **Defer and target** (`/defer [status|on|off|reset]`, `/target [<name>|reset]`). Adds `--defer --state <dir>` (and `--favor-state`) and `--target <name>` to the dbt commands Claude runs that do not set them, from the dbt Power User defer setting (`dbt_defer_state`) or your choice for the session. The target shows in the status line, and Claude's result says what the command ran as. | ||||||
| - **Docs coverage and propagation** (`/propagate`). After Claude edits a model's SQL, the model's documentation coverage (`dbt_docs_coverage`) is shown. After Claude writes a column description in a model's YAML, the downstream columns that carry the same value, as is or renamed, are offered as copies: tick the columns you want and press **Apply**. | ||||||
|
|
||||||
| The settings named above are the plugin's options in `/config`. The plugin's [README](https://github.com/AltimateAI/altimate-claude-plugin/blob/main/plugins/altimate-code/README.md) describes each pane in full. | ||||||
|
|
||||||
| ### The `/altimate` command, without the plugin | ||||||
|
|
||||||
| Run `/configure-claude` inside altimate to write the command: | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P3: The README now advertises the dbt helpers without stating their
altimate-code0.12.12 requirement. Add the prerequisite here so users following the top-level install path know older CLI versions will not provide these features.Prompt for AI agents