diff --git a/docs/docs/assets/css/extra.css b/docs/docs/assets/css/extra.css index 5d26b056be..5c7c736fa8 100644 --- a/docs/docs/assets/css/extra.css +++ b/docs/docs/assets/css/extra.css @@ -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 footer --- */ +.doc-links { + text-align: center; + font-size: 0.85rem; + line-height: 1.8; +} + +.doc-links a { + text-decoration: none; +} + +.doc-links a:hover { + text-decoration: underline; +} + +/* --- Dividers --- */ +.md-content hr { + margin: 1.5rem 0; +} diff --git a/docs/docs/assets/images/altimate-code-banner.png b/docs/docs/assets/images/altimate-code-banner.png new file mode 100644 index 0000000000..adcc814ab3 Binary files /dev/null and b/docs/docs/assets/images/altimate-code-banner.png differ diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md index b4224e4fa6..83a6a0c264 100644 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -1,5 +1,19 @@ # Getting Started +## Why altimate-code? + +Unlike general-purpose coding agents, altimate-code is built for data teams: + +| Capability | General coding agents | altimate-code | +|---|---|---| +| SQL anti-pattern detection | None | 19 rules with confidence scoring | +| Column-level lineage | None | Automatic from SQL | +| 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 | + ## Installation ```bash diff --git a/docs/docs/index.md b/docs/docs/index.md index 896ba8646c..b250a20117 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -1,90 +1,160 @@ -# altimate-code +--- +title: altimate-code +hide: + - toc +--- -**The data engineering agent for dbt, SQL, and cloud warehouses.** + -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. +
---- +

+ altimate-code +

+ +

The data engineering agent for
dbt, SQL, and cloud warehouses.

-## What makes it different +

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.

-Unlike general-purpose coding agents, altimate-code is built for data teams: +

-| 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 +

+ +
+ +
```bash -# Install npm install -g @altimateai/altimate-code +``` -# Launch the TUI -altimate-code +
-# 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. +

Built for data teams

+

Unlike general-purpose coding agents, every tool is purpose-built for data engineering workflows.

-## Choose your agent mode +
-| 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** + + --- -## Works with any LLM + Automatic lineage extraction from SQL. Trace any column back through joins, CTEs, and subqueries to its source. -altimate-code is model-agnostic. Use it with: +- :material-cash-multiple:{ .lg .middle } **FinOps & Cost Analysis** -- **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 + --- -## Supported warehouses + Credit analysis, expensive query detection, warehouse right-sizing, and unused resource cleanup. -- Snowflake (password + key-pair auth) -- BigQuery (service account + ADC) -- Databricks (PAT + Unity Catalog) -- PostgreSQL -- Redshift -- DuckDB (local development) -- MySQL -- SQL Server +- :material-translate:{ .lg .middle } **Cross-Dialect Translation** -## Documentation + --- -| 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 | + 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** + + --- + + Manifest parsing, test generation, model scaffolding, incremental model detection, and lineage-aware refactoring. + +
--- -!!! 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. +

Four specialized agents

+

Each agent has scoped permissions and purpose-built tools for its role.

+ +
+ +- :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** + + --- + + Cross-warehouse SQL translation, schema migration, and dialect conversion workflows. + +
+ +--- + +

Works with any LLM

+

Model-agnostic — bring your own provider or run locally.

+ +
+ +- :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** + +
+ +--- + +

Connects to your warehouse

+

First-class support for 8 data platforms.

+ +
+ +- :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** + +
+ +--- + +
+ +**Documentation** — [Getting Started](getting-started.md) | [Data Engineering](data-engineering/agent-modes.md) | [Configuration](configure/config.md) + +**Develop & Extend** — [SDK](develop/sdk.md) | [Plugins](develop/plugins.md) | [Server API](develop/server.md) + +
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index e56c42f8f0..318734ab31 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -11,8 +11,8 @@ theme: logo: assets/logo.png favicon: assets/images/favicon.png font: - text: Roboto - code: Roboto Mono + text: Inter + code: JetBrains Mono palette: - media: "(prefers-color-scheme: light)" scheme: default @@ -46,6 +46,10 @@ markdown_extensions: alternate_style: true - tables - attr_list + - md_in_html + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg nav: - Home: index.md