Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 159 additions & 0 deletions docs/docs/assets/css/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,162 @@
letter-spacing: 0.05em;
opacity: 1;
}

/* ================================================
HOMEPAGE
================================================ */

/* --- Hero section --- */
.hero {
text-align: center;
padding: 1.5rem 0 0.5rem;
}

.hero-banner {
max-width: 280px;
margin: 0 auto;
image-rendering: -webkit-optimize-contrast;
image-rendering: crisp-edges;
}

.hero-tagline {
font-size: 1.45rem;
font-weight: 700;
line-height: 1.3;
margin: 1rem 0 0.75rem;
color: var(--md-default-fg-color);
letter-spacing: -0.015em;
}

.hero-description {
font-size: 0.92rem;
max-width: 500px;
margin: 0 auto 1.5rem;
color: var(--md-default-fg-color--light);
line-height: 1.6;
}

.hero-actions {
display: flex;
justify-content: center;
gap: 0.6rem;
flex-wrap: wrap;
margin-bottom: 0;
}

.hero-actions .md-button {
font-size: 0.8rem;
padding: 0.5rem 1.4rem;
border-radius: 6px;
font-weight: 600;
}

/* Install snippet */
.hero-install {
max-width: 460px;
margin: 1.25rem auto 0;
}

.hero-install pre {
margin: 0;
}

.hero-install code {
font-size: 0.78rem;
}

/* --- Section headings --- */
.section-heading {
text-align: center;
font-size: 1.2rem;
font-weight: 700;
margin: 1.5rem 0 0.2rem;
letter-spacing: -0.01em;
}

.section-sub {
text-align: center;
color: var(--md-default-fg-color--light);
font-size: 0.85rem;
margin: 0 auto 1.25rem;
max-width: 460px;
line-height: 1.5;
}

/* --- Feature cards --- */
.grid.cards > ul > li {
border-radius: 8px;
padding: 0.8rem !important;
transition: box-shadow 0.2s ease, transform 0.2s ease;
}

.grid.cards > ul > li:hover {
box-shadow: 0 4px 16px rgba(0, 0, 0, 0.07);
transform: translateY(-1px);
}

[data-md-color-scheme="slate"] .grid.cards > ul > li:hover {
box-shadow: 0 4px 16px rgba(0, 0, 0, 0.3);
}

.grid.cards > ul > li p {
font-size: 0.83rem;
line-height: 1.55;
}

/* --- Pill grid (LLM providers, warehouses) --- */
.pill-grid {
max-width: 600px;
margin: 0 auto;
}

.pill-grid ul {
display: flex;
flex-wrap: wrap;
justify-content: center;
gap: 0.45rem;
list-style: none;
padding: 0;
margin: 0;
}

.pill-grid ul li {
display: inline-flex;
align-items: center;
gap: 0.3rem;
padding: 0.4rem 0.85rem;
border-radius: 100px;
font-size: 0.8rem;
border: 1px solid var(--md-default-fg-color--lightest);
color: var(--md-default-fg-color--light);
white-space: nowrap;
margin: 0;
}

.pill-grid ul li .twemoji {
display: inline-flex;
}

[data-md-color-scheme="slate"] .pill-grid ul li {
border-color: rgba(255, 255, 255, 0.12);
}

/* --- Doc links table --- */
.doc-links table {
font-size: 0.83rem;
}

.doc-links table th,
.doc-links table td {
border: none;
padding: 0.35rem 0.75rem;
}

.doc-links table th {
border-bottom: 1px solid var(--md-default-fg-color--lightest);
}

/* --- Dividers --- */
.md-content hr {
margin: 1.5rem 0;
}
Binary file added docs/docs/assets/images/altimate-code-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
201 changes: 137 additions & 64 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,90 +1,163 @@
# altimate-code
---
title: altimate-code
hide:
- toc
---

**The data engineering agent for dbt, SQL, and cloud warehouses.**
<style>
.md-content h1:first-child { display: none; }
.hero img { max-width: 280px; image-rendering: -webkit-optimize-contrast; image-rendering: crisp-edges; }
</style>

altimate-code is an AI-powered CLI agent with 55+ specialized tools for SQL analysis, schema inspection, column-level lineage, FinOps, and RBAC. It connects to your warehouse, understands your data, and helps you write better SQL, cut costs, and ship faster.
<div class="hero" markdown>

---
<p align="center">
<img src="assets/images/altimate-code-banner.png" alt="altimate-code" />
</p>

<p class="hero-tagline">The data engineering agent for<br/>dbt, SQL, and cloud warehouses.</p>

## What makes it different
<p class="hero-description">An AI-powered CLI with 55+ specialized tools — SQL analysis, schema inspection, column-level lineage, FinOps, and RBAC. Connects to your warehouse, understands your data, and helps you ship faster.</p>

Unlike general-purpose coding agents, altimate-code is built for data teams:
<p class="hero-actions" markdown>

| Capability | General coding agents | altimate-code |
|---|---|---|
| SQL anti-pattern detection | None | 19 rules with confidence scoring |
| Column-level lineage | None | Automatic from SQL |
| Cost prediction | None | 4-tier system trained on your query history |
| Schema-aware autocomplete | None | Indexes your warehouse metadata |
| Cross-dialect translation | None | Snowflake, BigQuery, Databricks, Redshift |
| FinOps analysis | None | Credit analysis, expensive queries, warehouse sizing |
| PII detection | None | Automatic column scanning |
| dbt integration | Basic file editing | Manifest parsing, test generation, model scaffolding |
[Get Started](getting-started.md){ .md-button .md-button--primary }
[View on GitHub :material-github:](https://github.com/AltimateAI/altimate-code){ .md-button }

## Quick start
</p>

</div>

<div class="hero-install" markdown>

```bash
# Install
npm install -g @altimateai/altimate-code
```

# Launch the TUI
altimate-code
</div>

# Or run with a specific model
altimate-code --model claude-sonnet-4-6
```
---

On first launch, run `/connect` to set up your LLM provider and warehouse connections.
<h2 class="section-heading">Built for data teams</h2>
<p class="section-sub">Unlike general-purpose coding agents, every tool is purpose-built for data engineering workflows.</p>

## Choose your agent mode
<div class="grid cards" markdown>

| Mode | Purpose | Permissions |
|---|---|---|
| **Builder** | Create dbt models, SQL pipelines, data transformations | Full read/write |
| **Analyst** | Explore data, run SELECT queries, generate insights | Read-only (enforced) |
| **Validator** | Data quality checks, schema validation, test coverage | Read + validate |
| **Migrator** | Cross-warehouse SQL translation and migration | Read/write for migration |
- :material-database-search:{ .lg .middle } **SQL Anti-Pattern Detection**

```bash
# Start in analyst mode (read-only, safe for production)
altimate-code --agent analyst
```
---

19 rules with confidence scoring. Catches SELECT *, missing filters, cartesian joins, non-sargable predicates, and more.

- :material-graph-outline:{ .lg .middle } **Column-Level Lineage**

---

Automatic lineage extraction from SQL. Trace any column back through joins, CTEs, and subqueries to its source.

- :material-cash-multiple:{ .lg .middle } **FinOps & Cost Analysis**

---

Credit analysis, expensive query detection, warehouse right-sizing, and unused resource cleanup.

- :material-translate:{ .lg .middle } **Cross-Dialect Translation**

---

Transpile SQL between Snowflake, BigQuery, Databricks, Redshift, PostgreSQL, and more.

- :material-shield-lock-outline:{ .lg .middle } **PII Detection & Safety**

---

Automatic column scanning for PII. Safety checks and policy enforcement before every query execution.

- :material-pipe:{ .lg .middle } **dbt Native**

---

## Works with any LLM
Manifest parsing, test generation, model scaffolding, incremental model detection, and lineage-aware refactoring.

altimate-code is model-agnostic. Use it with:
</div>

- **Anthropic** (Claude Opus, Sonnet, Haiku)
- **OpenAI / Codex** (GPT-4o, GPT-5, Codex subscription)
- **Google** (Gemini Pro, Flash)
- **AWS Bedrock** / **Azure OpenAI**
- **Ollama** (local models)
- **OpenRouter** (150+ models)
- Any OpenAI-compatible API
---

<h2 class="section-heading">Four specialized agents</h2>
<p class="section-sub">Each agent has scoped permissions and purpose-built tools for its role.</p>

<div class="grid cards" markdown>

- :material-hammer-wrench:{ .lg .middle } **Builder**

---

Create dbt models, SQL pipelines, and data transformations with full read/write access.

- :material-chart-bar:{ .lg .middle } **Analyst**

---

Explore data, run SELECT queries, and generate insights. Read-only access is enforced.

- :material-check-decagram:{ .lg .middle } **Validator**

---

Data quality checks, schema validation, test coverage analysis, and CI gating.

- :material-swap-horizontal:{ .lg .middle } **Migrator**

## Supported warehouses
---

- Snowflake (password + key-pair auth)
- BigQuery (service account + ADC)
- Databricks (PAT + Unity Catalog)
- PostgreSQL
- Redshift
- DuckDB (local development)
- MySQL
- SQL Server
Cross-warehouse SQL translation, schema migration, and dialect conversion workflows.

## Documentation
</div>

| Section | Description |
|---------|------------|
| [Getting Started](getting-started.md) | Installation, first run, warehouse configuration |
| [Usage](usage/tui.md) | TUI, CLI, web UI, IDE, and CI/CD integration |
| [Configure](configure/config.md) | Configuration, providers, tools, agents, themes, keybinds |
| [Data Engineering](data-engineering/agent-modes.md) | Agent modes, SQL/schema/FinOps/lineage/dbt tools, guides |
| [Develop](develop/sdk.md) | SDK, server API, plugins, ecosystem |
| [Troubleshooting](troubleshooting.md) | Logs, common issues, debug mode |
---

<h2 class="section-heading">Works with any LLM</h2>
<p class="section-sub">Model-agnostic — bring your own provider or run locally.</p>

<div class="pill-grid" markdown>

- :material-cloud: **Anthropic**
- :material-creation: **OpenAI**
- :material-google: **Google**
- :material-aws: **AWS Bedrock**
- :material-microsoft-azure: **Azure OpenAI**
- :material-server: **Ollama**
- :material-router-wireless: **OpenRouter**

</div>

---

!!! note
altimate-code is your cost advocate. Every tool is designed to minimize unnecessary warehouse spend. Cost prediction runs before every query, anti-patterns that burn credits are flagged automatically, and cheaper alternatives are always suggested.
<h2 class="section-heading">Connects to your warehouse</h2>
<p class="section-sub">First-class support for 8 data platforms.</p>

<div class="pill-grid" markdown>

- :material-snowflake: **Snowflake**
- :material-google-cloud: **BigQuery**
- :simple-databricks: **Databricks**
- :material-elephant: **PostgreSQL**
- :material-aws: **Redshift**
- :material-duck: **DuckDB**
- :material-database: **MySQL**
- :material-microsoft: **SQL Server**

</div>

---

<div class="doc-links" markdown>

| | |
|---|---|
| **Documentation** | **Develop & Extend** |
| [Getting Started](getting-started.md) — Install, configure, connect | [SDK](develop/sdk.md) — Build integrations |
| [Data Engineering](data-engineering/agent-modes.md) — Agent modes, tools, guides | [Plugins](develop/plugins.md) — Custom tools |
| [Configuration](configure/config.md) — Providers, agents, themes | [Server API](develop/server.md) — Headless mode |

</div>
Loading