Skip to content

Commit dca4903

Browse files
arora-saurabh448Saurabh Aroraclaude
authored
Documentation and readme updates for launch v0 (#236)
* fix: v0 of doc n readme fixes for launch * fix:structure sanity * fix: messaging on quickstart and home * fix: README updates * fix: matthew's comments * minor readme changes * fix:cleanup of llm slop * fix:remove uneccessary files --------- Co-authored-by: Saurabh Arora <saurabh@altimate.ai> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 58f9cd9 commit dca4903

File tree

15 files changed

+1334
-159
lines changed

15 files changed

+1334
-159
lines changed

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,9 @@ A clear and concise description of how you'd like it to work.
2121
## Alternatives Considered
2222

2323
A clear and concise description of any alternative solutions or features you've considered.
24+
25+
## Pre-submission Checklist
26+
27+
- [ ] I have searched existing issues and this is not a duplicate
28+
- [ ] I have described a concrete use case, not just a feature in the abstract
29+
- [ ] I understand that feature requests require a linked issue before a PR will be accepted

.github/workflows/docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ jobs:
4343
with:
4444
path: docs/site
4545

46+
4647
deploy:
4748
environment:
4849
name: github-pages

README.md

Lines changed: 100 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,99 @@
11
<div align="center">
22

3-
<img src="docs/docs/assets/images/altimate-code-banner.png" alt="altimate-code" width="600" />
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="docs/docs/assets/images/altimate-code-banner.png" />
5+
<img src="docs/docs/assets/images/altimate-code-banner.png" alt="altimate-code" width="600" />
6+
</picture>
47

5-
**The data engineering agent for dbt, SQL, and cloud warehouses.**
8+
**The open-source data engineering harness.**
69

7-
An AI-powered CLI with 99+ specialized tools — SQL analysis, schema inspection,
8-
column-level lineage, FinOps, PII detection, and data visualization. Connects to your warehouse,
9-
understands your data, and helps you ship faster.
10+
The intelligence layer for data engineering AI — 99+ deterministic tools for SQL analysis,
11+
column-level lineage, dbt, FinOps, and warehouse connectivity across every major cloud platform.
12+
13+
Run standalone in your terminal, embed underneath Claude Code or Codex, or integrate
14+
into CI pipelines and orchestration DAGs. Precision data tooling for any LLM.
1015

1116
[![npm](https://img.shields.io/npm/v/@altimateai/altimate-code)](https://www.npmjs.com/package/@altimateai/altimate-code)
1217
[![npm](https://img.shields.io/npm/v/@altimateai/altimate-core)](https://www.npmjs.com/package/@altimateai/altimate-core)
18+
[![npm downloads](https://img.shields.io/npm/dm/@altimateai/altimate-code)](https://www.npmjs.com/package/@altimateai/altimate-code)
1319
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
1420
[![CI](https://github.com/AltimateAI/altimate-code/actions/workflows/ci.yml/badge.svg)](https://github.com/AltimateAI/altimate-code/actions/workflows/ci.yml)
15-
[![Docs](https://img.shields.io/badge/docs-altimate--code.sh-blue)](https://altimate.ai)
21+
[![Slack](https://img.shields.io/badge/Slack-Join%20Community-4A154B?logo=slack)](https://altimate.ai/slack)
22+
[![Docs](https://img.shields.io/badge/docs-altimateai.github.io-blue)](https://altimateai.github.io/altimate-code)
1623

1724
</div>
1825

1926
---
2027

21-
## Why altimate?
28+
## Install
29+
30+
```bash
31+
# npm (recommended)
32+
npm install -g @altimateai/altimate-code
33+
34+
# Homebrew
35+
brew install AltimateAI/tap/altimate-code
36+
```
37+
38+
Then — in order:
39+
40+
**Step 1: Configure your LLM provider** (required before anything works):
41+
```bash
42+
altimate # Launch the TUI
43+
/connect # Interactive setup — choose your provider and enter your API key
44+
```
45+
46+
> **No API key?** Select **Codex** in the `/connect` menu — it's built-in and requires no setup.
2247
23-
General-purpose coding agents can write SQL, but they don't *understand* it. They can't trace lineage, detect anti-patterns, check PII exposure, or optimize warehouse costs — because they don't have the tools.
48+
Or set an environment variable directly:
49+
```bash
50+
export ANTHROPIC_API_KEY=your_key # Anthropic Claude
51+
export OPENAI_API_KEY=your_key # OpenAI
52+
```
53+
54+
**Step 2 (optional): Auto-detect your data stack** (read-only, safe for production connections):
55+
```bash
56+
altimate /discover
57+
```
58+
59+
`/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+
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.
2462
25-
altimate is a fork of [OpenCode](https://github.com/anomalyco/opencode) rebuilt for data teams. It gives any LLM access to 99+ specialized data engineering tools, 12 purpose-built skills, and direct warehouse connectivity — so the AI works with your actual schemas, not guesses.
63+
## Why a specialized harness?
2664

27-
## General agents vs altimate
65+
General AI coding agents can edit SQL files. They cannot *understand* your data stack.
66+
altimate gives any LLM a deterministic data engineering intelligence layer —
67+
no hallucinated SQL advice, no guessing at schema, no missed PII.
2868

2969
| Capability | General coding agents | altimate |
3070
|---|---|---|
31-
| SQL anti-pattern detection | None | 19 rules with confidence scoring |
32-
| Column-level lineage | None | Automatic from SQL |
33-
| Schema-aware autocomplete | None | Indexes your warehouse metadata |
34-
| Cross-dialect translation | None | Snowflake, BigQuery, Databricks, Redshift |
35-
| FinOps analysis | None | Credit analysis, expensive queries, warehouse sizing |
36-
| PII detection | None | Automatic column scanning |
37-
| dbt integration | Basic file editing | Manifest parsing, test generation, model scaffolding |
71+
| SQL anti-pattern detection | None | 19 rules, confidence-scored |
72+
| Column-level lineage | None | Automatic from SQL, any dialect |
73+
| Schema-aware autocomplete | None | Live-indexed warehouse metadata |
74+
| Cross-dialect SQL translation | None | SnowflakeBigQueryDatabricks Redshift |
75+
| FinOps & cost analysis | None | Credits, expensive queries, right-sizing |
76+
| PII detection | None | 30+ regex patterns, 15 categories |
77+
| dbt integration | Basic file editing | Manifest parsing, test gen, model scaffolding, lineage |
3878
| Data visualization | None | Auto-generated charts from SQL results |
3979
| Observability | None | Local-first tracing of AI sessions and tool calls |
4080

81+
> **Benchmarked precision:** 100% F1 on SQL anti-pattern detection (1,077 queries, 19 rules, 0 false positives).
82+
> 100% edge-match on column-level lineage (500 queries, 13 categories).
83+
> [See methodology →](experiments/BENCHMARKS.md)
84+
85+
**What the harness provides:**
86+
- **SQL Intelligence Engine** — deterministic SQL parsing and analysis (not LLM pattern matching). 19 rules, 100% F1, 0 false positives. Built for data engineers who've been burned by hallucinated SQL advice.
87+
- **Column-Level Lineage** — automatic extraction from SQL across dialects. 100% edge-match on 500 benchmark queries.
88+
- **Live Warehouse Intelligence** — indexed schemas, query history, and cost data from your actual warehouse. Not guesses.
89+
- **dbt Native** — manifest parsing, test generation, model scaffolding, medallion patterns, impact analysis
90+
- **FinOps** — credit consumption, expensive query detection, warehouse right-sizing, idle resource cleanup
91+
- **PII Detection** — 15 categories, 30+ regex patterns, enforced pre-execution
92+
93+
**Works seamlessly with Claude Code and Codex.** altimate is the data engineering tool layer — use it standalone in your terminal, or mount it as the harness underneath whatever AI agent you already run. The two are complementary.
94+
95+
altimate is a fork of [OpenCode](https://github.com/anomalyco/opencode) rebuilt for data teams. Model-agnostic — bring your own LLM or run locally with Ollama.
96+
4197
## Quick demo
4298

4399
```bash
@@ -59,6 +115,8 @@ altimate is a fork of [OpenCode](https://github.com/anomalyco/opencode) rebuilt
59115
60116
## Key Features
61117
118+
All features are deterministic — they parse, trace, and measure. Not LLM pattern matching.
119+
62120
### SQL Anti-Pattern Detection
63121
19 rules with confidence scoring — catches SELECT *, cartesian joins, non-sargable predicates, correlated subqueries, and more. **100% accuracy** on 1,077 benchmark queries.
64122
@@ -86,27 +144,6 @@ Built-in observability for AI interactions — trace tool calls, token usage, an
86144
### AI Teammate Training
87145
Teach your AI teammate project-specific patterns, naming conventions, and best practices. The training system learns from examples and applies rules automatically across sessions.
88146
89-
## Install
90-
91-
```bash
92-
# npm (recommended)
93-
npm install -g altimate-code
94-
95-
# Homebrew
96-
brew install AltimateAI/tap/altimate-code
97-
```
98-
99-
Then:
100-
101-
```bash
102-
altimate # Launch the interactive TUI
103-
altimate /discover # Auto-detect your data stack and go
104-
```
105-
106-
> **Note:** `altimate-code` still works as a backward-compatible alias.
107-
108-
`/discover` auto-detects dbt projects, warehouse connections (from `~/.dbt/profiles.yml`, Docker, environment variables), and installed tools (dbt, sqlfluff, airflow, dagster, and more).
109-
110147
## Agent Modes
111148
112149
Each agent has scoped permissions and purpose-built tools for its role.
@@ -117,8 +154,12 @@ Each agent has scoped permissions and purpose-built tools for its role.
117154
| **Analyst** | Explore data, run SELECT queries, and generate insights | Read-only enforced |
118155
| **Validator** | Data quality checks, schema validation, test coverage analysis | Read + validate |
119156
| **Migrator** | Cross-warehouse SQL translation, schema migration, dialect conversion | Read/write for migrations |
157+
| **Researcher** | Deep-dive analysis, documentation research, and knowledge extraction | Read-only |
158+
| **Trainer** | Teach project-specific patterns, naming conventions, and best practices | Read + write training data |
120159
| **Executive** | Business-audience summaries — translates findings into revenue, cost, and compliance impact | Read-only |
121160
161+
> **New to altimate?** Start with **Analyst mode** — it's read-only and safe to run against production connections.
162+
122163
## Supported Warehouses
123164
124165
Snowflake · BigQuery · Databricks · PostgreSQL · Redshift · DuckDB · MySQL · SQL Server
@@ -131,6 +172,12 @@ Model-agnostic — bring your own provider or run locally.
131172
132173
Anthropic · OpenAI · Google Gemini · Google Vertex AI · Amazon Bedrock · Azure OpenAI · Mistral · Groq · DeepInfra · Cerebras · Cohere · Together AI · Perplexity · xAI · OpenRouter · Ollama · GitHub Copilot
133174
175+
> **No API key?** **Codex** is a built-in provider with no key required. Select it via `/connect` to start immediately.
176+
177+
## Skills
178+
179+
altimate ships with built-in skills for every common data engineering task — type `/` in the TUI to browse available skills and get autocomplete. No memorization required.
180+
134181
## Architecture
135182
136183
```
@@ -158,37 +205,31 @@ packages/
158205
drivers/ Shared database drivers (10 warehouses)
159206
dbt-tools/ dbt integration (TypeScript)
160207
plugin/ Plugin system
161-
sdk/js/ JavaScript SDK
208+
sdk/ SDKs (includes VS Code extension)
162209
util/ Shared utilities
163210
```
164211
165-
## Documentation
166-
167-
Full docs at **[altimate.ai](https://altimate.ai)**.
168-
169-
- [Getting Started](https://altimate.ai/getting-started/)
170-
- [SQL Tools](https://altimate.ai/data-engineering/tools/sql-tools/)
171-
- [Agent Modes](https://altimate.ai/data-engineering/agent-modes/)
172-
- [Configuration](https://altimate.ai/configure/model-providers/)
173-
174212
## Community & Contributing
175213
176-
- **Issues**: [GitHub Issues](https://github.com/AltimateAI/altimate-code/issues)
177-
- **Discussions**: [GitHub Discussions](https://github.com/AltimateAI/altimate-code/discussions)
178-
- **Security**: See [SECURITY.md](./SECURITY.md)
214+
- **Slack**: [altimate.ai/slack](https://altimate.ai/slack) — Real-time chat for questions, showcases, and feature discussion
215+
- **Issues**: [GitHub Issues](https://github.com/AltimateAI/altimate-code/issues) — Bug reports and feature requests
216+
- **Discussions**: [GitHub Discussions](https://github.com/AltimateAI/altimate-code/discussions) — Long-form questions and proposals
217+
- **Security**: See [SECURITY.md](./SECURITY.md) for responsible disclosure
179218
180-
Contributions welcome! Please read the [Contributing Guide](./CONTRIBUTING.md) before opening a PR.
219+
Contributions welcome — docs, SQL rules, warehouse connectors, and TUI improvements are all needed. The contributing guide covers setup, the vouch system, and the issue-first PR policy.
181220
182-
```bash
183-
git clone https://github.com/AltimateAI/altimate-code.git
184-
cd altimate-code
185-
bun install
186-
```
221+
**[Read CONTRIBUTING.md →](./CONTRIBUTING.md)**
187222
188-
## Acknowledgements
223+
## What's New
189224
190-
altimate is a fork of [OpenCode](https://github.com/anomalyco/opencode), the open-source AI coding agent. We build on top of their excellent foundation to add data-team-specific capabilities.
225+
- **v0.4.1** (March 2026) — env-based skill selection, session caching, tracing improvements
226+
- **v0.4.0** (Feb 2026) — data visualization skill, 99+ tools, training system
227+
- **v0.3.x** — [See full changelog →](CHANGELOG.md)
191228
192229
## License
193230
194231
MIT — see [LICENSE](./LICENSE).
232+
233+
## Acknowledgements
234+
235+
altimate is a fork of [OpenCode](https://github.com/anomalyco/opencode), the open-source AI coding agent. We build on top of their excellent foundation to add data-team-specific capabilities.

docs/docs/configure/skills.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,13 @@ Focus on the query: $ARGUMENTS
3434

3535
Skills are loaded from these locations (in priority order):
3636

37-
1. **External directories** (if not disabled):
38-
- `~/.claude/skills/`
39-
- `~/.agents/skills/`
40-
- `.claude/skills/` (project, searched up tree)
41-
- `.agents/skills/` (project, searched up tree)
42-
43-
2. **altimate-code directories**:
37+
1. **altimate-code directories** (project-scoped, highest priority):
4438
- `.altimate-code/skill/`
4539
- `.altimate-code/skills/`
4640

41+
2. **Global user directories**:
42+
- `~/.altimate-code/skills/`
43+
4744
3. **Custom paths** (from config):
4845

4946
```json
@@ -54,7 +51,11 @@ Skills are loaded from these locations (in priority order):
5451
}
5552
```
5653

57-
4. **Remote URLs** (from config):
54+
4. **External directories & remote URLs** (if not disabled):
55+
- `~/.claude/skills/`
56+
- `~/.agents/skills/`
57+
- `.claude/skills/` (project, searched up tree)
58+
- `.agents/skills/` (project, searched up tree)
5859

5960
```json
6061
{
@@ -66,13 +67,9 @@ Skills are loaded from these locations (in priority order):
6667

6768
## Built-in Data Engineering Skills
6869

69-
altimate includes skills for common data engineering tasks:
70+
altimate ships with built-in skills for common data engineering tasks. Skills are loaded and surfaced dynamically at runtime — type `/` in the TUI to browse what's available and get autocomplete on skill names.
7071

71-
- SQL analysis and optimization
72-
- dbt model generation
73-
- Schema exploration
74-
- Cost estimation
75-
- Migration planning
72+
For custom skills, see [Adding Custom Skills](#adding-custom-skills) below.
7673

7774
## Disabling External Skills
7875

0 commit comments

Comments
 (0)