You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: sync missing content from v2 and rename What's New to Changelog (#284)
* docs: update README and docs for v0.4.2 launch
- Standardize tool count to 100+ across all docs (was 99+/55+)
- Update install command to unscoped `altimate-code` package
- Remove stale Python/uv auto-setup claims (all-native TypeScript now)
- Update docs badge URL to docs.altimate.sh
- Remove altimate-core npm badge from README
- Add --yolo flag to CLI reference and builder mode subtext
- Add new env vars (YOLO, MEMORY, TRAINING) to CLI docs
- Add prompt enhancement keybind (leader+i) to TUI and keybinds docs
- Add tool_lookup to tools index
- Add built-in skills table (sql-review, schema-migration, pii-audit, etc.)
- Add altimate-dbt CLI section to dbt-tools.md
- Add Oracle and SQLite to warehouse lists
- Update security FAQ: replace Python engine FAQ with native engine, add sensitive_write FAQ
- Update telemetry docs to remove Python engine references
- Add v0.4.2 to README "What's New" section
- Update llms.txt URLs to docs.altimate.sh and bump version to v0.4.2
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: simplify zero-setup messaging in README and quickstart
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: simplify install callout to "zero additional setup"
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: trim install callout
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: remove em-dashes, fix pill spacing, simplify /discover duplication
- Replace 304 em-dashes across 38 docs files with natural sentence
structures (colons, commas, periods, split sentences) to avoid
AI-generated content appearance
- Fix pill-grid CSS: increase gap/padding, add responsive breakpoints
at 768px and 480px for reliable scaling across viewport sizes
- Simplify quickstart /discover step to brief description + link to
Full Setup; add (Optional) marker to getting-started warehouse step
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: overhaul getting-started pages with comprehensive setup guide
Rewrite quickstart as a full Setup page covering warehouse connections,
LLM provider switching, agent modes, skills, and permissions. Update
overview page with ADE-Bench results (74.4%), fix install command, and
change 70+ to 50+ tools. Replace query example with NYC taxi cab
analytics prompt. Remove time blocks from step headings and trim
redundant sections.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: move CI & Headless under Interfaces, deduplicate from CLI
Move CI page from data-engineering/guides to usage/. Remove duplicate
non-interactive and tracing sections from CLI page, link to CI instead.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: simplify agents page, quickstart next-steps, and nav label
Remove data-engineering-specific agent table from agents.md (now covered
elsewhere), replace grid cards in quickstart with a compact link list,
and rename "Complete Setup" → "Setup" in nav.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: sync missing content from v2, rename What's New to Changelog
- Rename "What's New" to "Changelog" across docs, nav, and README
- Populate changelog with full release history (v0.1.0 through v0.4.9)
- Add inline permission examples to security-faq (permission table, JSON configs)
- Add Data Engineering agents table and Agent Permissions example to agents page
- Add Non-interactive Usage and Tracing sections to CLI docs
- Add missing nav entries: Web UI, Claude Code/Codex guides, Memory Tools,
Observability (Tracing/Telemetry), Training, and Extend (SDK/Server/Plugins/Ecosystem)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: update tool count from 50+ to 100+ across all docs
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix broken anchors, tool counts, changelog, nav, and hero copy
- Fix broken anchor link to #step-3-configure-your-warehouse-optional
- Add inline "Adding Custom Skills" section in skills.md
- Fix changelog upgrade command to use unscoped package name
- Split merged 0.4.1/0.4.2 changelog into separate sections
- Update tool count from 70+ to 100+ in configure/tools pages
- Move Guides to bottom of Use section in nav
- Change hero tagline to "Open-source data engineering harness."
- Simplify install command to just npm install
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: sync agent modes from PR #282, Claude/Codex commands from #235, stub web UI
- Reduce agent modes from 7 to 3 (builder, analyst, plan) per PR #282
- Add SQL Write Access Control section with query classification table
- Add sql_execute_write permission to permissions reference
- Update /data to /altimate in Claude Code guide, add /configure-claude setup
- Add Codex CLI skill integration and /configure-codex setup
- Add /configure-claude and /configure-codex to commands reference
- Stub web UI page with Coming Soon notice
- Update all cross-references (getting-started, quickstart, index, tui, training, migration)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix stale llms.txt URLs, add v0.5.0 changelog entry
- Fix 4 broken URLs in llms.txt (network, telemetry, security-faq,
troubleshooting) to match reference/ paths in mkdocs nav
- Update llms.txt version from v0.4.2 to v0.5.0
- Add missing v0.5.0 changelog entry with features and fixes
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Saurabh Arora <saurabh@altimate.ai>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@@ -29,7 +28,7 @@ into CI pipelines and orchestration DAGs. Precision data tooling for any LLM.
29
28
30
29
```bash
31
30
# npm (recommended)
32
-
npm install -g @altimateai/altimate-code
31
+
npm install -g altimate-code
33
32
34
33
# Homebrew
35
34
brew install AltimateAI/tap/altimate-code
@@ -58,7 +57,7 @@ altimate /discover
58
57
59
58
`/discover` auto-detects dbt projects, warehouse connections (from `~/.dbt/profiles.yml`, Docker, environment variables), and installed tools (dbt, sqlfluff, airflow, dagster, and more). Skip this and start building — you can always run it later.
60
59
61
-
> **Zero Python setup required.**On first run, the CLI automatically downloads [`uv`](https://github.com/astral-sh/uv), creates an isolated Python environment, and installs the data engine with all warehouse drivers. No `pip install`, no virtualenv management.
60
+
> **Zero additional setup.**One command install.
62
61
63
62
## Why a specialized harness?
64
63
@@ -162,7 +161,7 @@ Each agent has scoped permissions and purpose-built tools for its role.
162
161
163
162
## Supported Warehouses
164
163
165
-
Snowflake · BigQuery · Databricks · PostgreSQL · Redshift · DuckDB · MySQL · SQL Server
164
+
Snowflake · BigQuery · Databricks · PostgreSQL · Redshift · DuckDB · MySQL · SQL Server · Oracle · SQLite
166
165
167
166
First-class support with schema indexing, query execution, and metadata introspection. SSH tunneling available for secure connections.
Full access mode. Can read/write files, run any bash command (with approval), execute SQL, and modify dbt models. SQL write operations (`INSERT`, `UPDATE`, `DELETE`, `CREATE`, etc.) prompt for user approval. Destructive SQL (`DROP DATABASE`, `DROP SCHEMA`, `TRUNCATE`) is hard-blocked.
Multi-statement queries (`SELECT 1; INSERT INTO ...`) are classified as write if any statement is a write.
27
47
28
48
## Custom Agents
29
49
@@ -86,11 +106,11 @@ You are a Snowflake cost optimization expert. For every query:
86
106
```
87
107
88
108
!!! info
89
-
Markdown agent files use YAML frontmatter for configuration and the body as the system prompt. This is a convenient way to define agents without editing your main config file.
109
+
Markdown agent files use YAML frontmatter for configuration and the body as the system prompt.
90
110
91
111
## Agent Permissions
92
112
93
-
Each agent can have its own permission overrides that restrict or expand the default permissions:
113
+
Each agent can have its own permission overrides:
94
114
95
115
```json
96
116
{
@@ -99,10 +119,11 @@ Each agent can have its own permission overrides that restrict or expand the def
99
119
"permission": {
100
120
"write": "deny",
101
121
"edit": "deny",
122
+
"sql_execute_write": "deny",
102
123
"bash": {
103
-
"dbt show *": "allow",
124
+
"*": "deny",
104
125
"dbt list *": "allow",
105
-
"*": "deny"
126
+
"ls *": "allow"
106
127
}
107
128
}
108
129
}
@@ -117,4 +138,4 @@ Each agent can have its own permission overrides that restrict or expand the def
117
138
118
139
-**TUI**: Press leader + `a` or use `/agent <name>`
Copy file name to clipboardExpand all lines: docs/docs/configure/commands.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ altimate ships with six built-in slash commands:
8
8
|---------|-------------|
9
9
|`/init`| Create or update an AGENTS.md file with build commands and code style guidelines. |
10
10
|`/discover`| Scan your data stack and set up warehouse connections. Detects dbt projects, warehouse connections from profiles/Docker/env vars, installed tools, and config files. Walks you through adding and testing new connections, then indexes schemas. |
11
-
|`/review`| Review changes — accepts`commit`, `branch`, or `pr` as an argument (defaults to uncommitted changes). |
11
+
|`/review`| Review changes. Accepts`commit`, `branch`, or `pr` as an argument (defaults to uncommitted changes). |
12
12
|`/feedback`| Submit product feedback as a GitHub issue. Guides you through title, category, description, and optional session context. |
13
13
|`/configure-claude`| Configure altimate as a `/altimate` slash command in [Claude Code](https://claude.com/claude-code). Writes `~/.claude/commands/altimate.md` so you can invoke altimate from within Claude Code sessions. |
14
14
|`/configure-codex`| Configure altimate as a skill in [Codex CLI](https://developers.openai.com/codex). Creates `~/.codex/skills/altimate/SKILL.md` so Codex can delegate data engineering tasks to altimate. |
@@ -37,10 +37,10 @@ The recommended way to set up a new data engineering project. Run `/discover` in
37
37
38
38
Submit product feedback directly from the CLI. The agent walks you through:
39
39
40
-
1.**Title** — a short summary of your feedback
41
-
2.**Category** — bug, feature, improvement, or ux
42
-
3.**Description**— detailed explanation
43
-
4.**Session context** (opt-in) — includes working directory name and session ID for debugging
40
+
1.**Title**, a short summary of your feedback
41
+
2.**Category**: bug, feature, improvement, or ux
42
+
3.**Description**with a detailed explanation
43
+
4.**Session context** (opt-in), which includes working directory name and session ID for debugging
44
44
45
45
```
46
46
/feedback # start the guided feedback flow
@@ -137,7 +137,7 @@ Commands are loaded from:
137
137
138
138
Press leader + `/` to see all available commands.
139
139
140
-
## External CLI integration
140
+
## External CLI Integration
141
141
142
142
The `/configure-claude` and `/configure-codex` commands write integration files to external CLI tools:
@@ -149,7 +149,7 @@ Control how context is managed when conversations grow long:
149
149
|-------|---------|-------------|
150
150
|`auto`|`true`| Auto-compact when context is full |
151
151
|`prune`|`true`| Prune old tool outputs |
152
-
|`reserved`|—| Token buffer to reserve |
152
+
|`reserved`|(none)| Token buffer to reserve |
153
153
154
154
!!! info
155
155
Compaction automatically summarizes older messages to free up context window space, allowing longer conversations without losing important context. See [Context Management](context-management.md) for full details.
Copy file name to clipboardExpand all lines: docs/docs/configure/context-management.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
# Context Management
2
2
3
-
altimate automatically manages conversation context so you can work through long sessions without hitting model limits. When a conversation grows large, the CLI summarizes older messages, prunes stale tool outputs, and recovers from provider overflow errors — all without losing the important details of your work.
3
+
altimate automatically manages conversation context so you can work through long sessions without hitting model limits. When a conversation grows large, the CLI summarizes older messages, prunes stale tool outputs, and recovers from provider overflow errors, all without losing the important details of your work.
4
4
5
5
## How It Works
6
6
7
7
Every LLM has a finite context window. As you work, each message, tool call, and tool result adds tokens to the conversation. When the conversation approaches the model's limit, altimate takes action:
8
8
9
-
1.**Prune** — Old tool outputs (file reads, command results, query results) are replaced with compact summaries
10
-
2.**Compact** — The entire conversation history is summarized into a continuation prompt
11
-
3.**Continue** — The agent picks up where it left off using the summary
9
+
1.**Prune.** Old tool outputs (file reads, command results, query results) are replaced with compact summaries
10
+
2.**Compact.** The entire conversation history is summarized into a continuation prompt
11
+
3.**Continue.** The agent picks up where it left off using the summary
12
12
13
13
This happens automatically by default. You do not need to manually manage context.
14
14
@@ -38,7 +38,7 @@ When a tool output is pruned, it is replaced with a brief fingerprint:
38
38
[Tool output cleared — read_file(file: src/main.ts) returned 42 lines, 1.2 KB — "import { App } from './app'"]
39
39
```
40
40
41
-
This tells the model what tool was called, what arguments were used, how much output it produced, and the first line of the result — enough to maintain continuity without consuming tokens.
41
+
This tells the model what tool was called, what arguments were used, how much output it produced, and the first line of the result. That is enough to maintain continuity without consuming tokens.
42
42
43
43
**Pruning rules:**
44
44
@@ -51,12 +51,12 @@ This tells the model what tool was called, what arguments were used, how much ou
51
51
52
52
Compaction is aware of data engineering workflows. When summarizing a conversation, the compaction prompt preserves:
53
53
54
-
-**Warehouse connections** — which databases or warehouses are connected
55
-
-**Schema context** — discovered tables, columns, and relationships
56
-
-**dbt project state** — models, sources, tests, and project structure
57
-
-**Lineage findings** — upstream and downstream dependencies
58
-
-**Query patterns** — SQL dialects, anti-patterns, and optimization opportunities
59
-
-**FinOps context** — cost findings and warehouse sizing recommendations
54
+
-**Warehouse connections**, including which databases or warehouses are connected
55
+
-**Schema context**, including discovered tables, columns, and relationships
56
+
-**dbt project state**, including models, sources, tests, and project structure
57
+
-**Lineage findings**, including upstream and downstream dependencies
58
+
-**Query patterns**, including SQL dialects, anti-patterns, and optimization opportunities
59
+
-**FinOps context**, including cost findings and warehouse sizing recommendations
60
60
61
61
This means you can run a long data exploration session and compaction will not lose track of what schemas you discovered, what dbt models you were working with, or what cost optimizations you identified.
Most people think of governance as a cost — something you bolt on for compliance. In practice, governance makes agents produce **better results**, not just safer ones.
4
+
5
+
LLMs have built-in randomization. Give them too much freedom and they explore dead ends, burn tokens, and produce inconsistent output. Constrain the solution space and they get to correct results faster, in fewer tokens, with more consistency.
6
+
7
+
Task-scoped permissions aren't just about safety — they're about **focus**. When an Analyst agent knows it can only `SELECT`, it doesn't waste cycles considering whether to `CREATE` a temp table. When it has prescribed, deterministic tools for tracing lineage instead of trying to figure it out from scratch, the results are the same every time.
8
+
9
+
There's an audit angle too. In regulated industries, prescribed tooling eliminates unnecessary audit cycles. When your tools generate SQL the same way every time, auditors can verify consistency. Change the SQL — even if the results are conceptually identical — and you trigger an investigation to prove equivalence. Deterministic tooling removes that overhead entirely.
10
+
11
+
Altimate Code enforces governance at the **harness level**, not via prompt instructions the model can ignore. Four mechanisms work together:
12
+
13
+
## Rules
14
+
15
+
Project rules via `AGENTS.md` files guide agent behavior — coding conventions, naming standards, warehouse policies, and workflow instructions. Rules are loaded automatically from well-known file patterns and merged into the agent's system prompt. Place them at your project root, in subdirectories for scoped guidance, or host them remotely for organization-wide standards.
Every tool has a permission level — `allow`, `ask`, or `deny` — configurable globally or per agent. The Analyst agent can't `INSERT`, `UPDATE`, `DELETE`, or `DROP`. That's not a prompt instruction the model can choose to ignore. It's enforced at the tool level. Pattern-based permissions give you fine-grained control: allow `dbt build *` but deny `rm -rf *`.
Long sessions produce large conversation histories that can exceed model context windows. Altimate Code automatically prunes old tool outputs, compacts conversations into summaries, and recovers from provider overflow errors — all while preserving critical data engineering context like warehouse connections, schema discoveries, lineage findings, and cost analysis results.
Every file edit is auto-formatted before it's written. This isn't optional consistency — it's enforced consistency. Altimate Code detects file types and runs the appropriate formatter (prettier, ruff, gofmt, sqlfluff, and 20+ others) automatically. The agent can't produce code that violates your formatting standards.
Together, these four mechanisms mean governance is not an afterthought — it's built into every agent interaction. The harness enforces the rules so your team doesn't have to police the output.
0 commit comments