diff --git a/README.md b/README.md index 7a9850dcb..f9ec72640 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,8 @@ Run standalone in your terminal, embed underneath Claude Code or Codex, or integ into CI pipelines and orchestration DAGs. Precision data tooling for any LLM. [![npm](https://img.shields.io/npm/v/altimate-code)](https://www.npmjs.com/package/altimate-code) -[![npm downloads](https://img.shields.io/npm/dm/altimate-code)](https://www.npmjs.com/package/altimate-code) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE) -[![CI](https://github.com/AltimateAI/altimate-code/actions/workflows/ci.yml/badge.svg)](https://github.com/AltimateAI/altimate-code/actions/workflows/ci.yml) -[![Slack](https://img.shields.io/badge/Slack-Join%20Community-4A154B?logo=slack)](https://altimate.ai/slack) +[![Slack](https://img.shields.io/badge/Slack-Join%20Community-4A154B?logo=slack)](https://altimate.studio/join-agentic-data-engineering-slack) [![Docs](https://img.shields.io/badge/docs-docs.altimate.sh-blue)](https://docs.altimate.sh) @@ -42,8 +40,6 @@ altimate # Launch the TUI /connect # Interactive setup — choose your provider and enter your API key ``` -> **No API key?** Select **Codex** in the `/connect` menu — it's built-in and requires no setup. - Or set an environment variable directly: ```bash export ANTHROPIC_API_KEY=your_key # Anthropic Claude @@ -57,6 +53,8 @@ altimate /discover `/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. +> **Headless / scripted usage:** `altimate --yolo` auto-approves all permission prompts. Not recommended with live warehouse connections. + > **Zero additional setup.** One command install. ## Why a specialized harness? @@ -89,7 +87,7 @@ no hallucinated SQL advice, no guessing at schema, no missed PII. - **FinOps** — credit consumption, expensive query detection, warehouse right-sizing, idle resource cleanup - **PII Detection** — 15 categories, 30+ regex patterns, enforced pre-execution -**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. +**Works seamlessly with Claude Code and Codex.** Use `/configure-claude` or `/configure-codex` to set up integration in one step. 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. 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. @@ -145,19 +143,15 @@ Teach your AI teammate project-specific patterns, naming conventions, and best p ## Agent Modes -Each agent has scoped permissions and purpose-built tools for its role. +Each mode has scoped permissions, tool access, and SQL write-access control. -| Agent | Role | Access | +| Mode | Role | Access | |---|---|---| -| **Builder** | Create dbt models, SQL pipelines, and data transformations | Full read/write | -| **Analyst** | Explore data, run SELECT queries, and generate insights | Read-only enforced | -| **Validator** | Data quality checks, schema validation, test coverage analysis | Read + validate | -| **Migrator** | Cross-warehouse SQL translation, schema migration, dialect conversion | Read/write for migrations | -| **Researcher** | Deep-dive analysis, documentation research, and knowledge extraction | Read-only | -| **Trainer** | Teach project-specific patterns, naming conventions, and best practices | Read + write training data | -| **Executive** | Business-audience summaries — translates findings into revenue, cost, and compliance impact | Read-only | +| **Builder** | Create dbt models, SQL pipelines, and data transformations | Full read/write (write SQL prompts for approval; `DROP DATABASE`/`DROP SCHEMA`/`TRUNCATE` hard-blocked) | +| **Analyst** | Explore data, run SELECT queries, FinOps analysis, and generate insights | Read-only enforced (SELECT only, no file writes) | +| **Plan** | Outline an approach before acting | Minimal (read files only, no SQL or bash) | -> **New to altimate?** Start with **Analyst mode** — it's read-only and safe to run against production connections. +> **New to altimate?** Start with **Analyst mode** — it's read-only and safe to run against production connections. Need specialized workflows (validation, migration, research)? Create [custom agent modes](https://docs.altimate.sh). ## Supported Warehouses @@ -171,46 +165,13 @@ Model-agnostic — bring your own provider or run locally. Anthropic · OpenAI · Google Gemini · Google Vertex AI · Amazon Bedrock · Azure OpenAI · Mistral · Groq · DeepInfra · Cerebras · Cohere · Together AI · Perplexity · xAI · OpenRouter · Ollama · GitHub Copilot -> **No API key?** **Codex** is a built-in provider with no key required. Select it via `/connect` to start immediately. - ## Skills 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. -## Architecture - -``` -altimate (TypeScript CLI) - | - @altimateai/altimate-core (napi-rs → Rust) - SQL analysis, lineage, PII, safety — 45 functions, ~2ms per call - | - Native Node.js drivers - 10 warehouses: Snowflake, BigQuery, PostgreSQL, Databricks, - Redshift, MySQL, SQL Server, Oracle, DuckDB, SQLite -``` - -The CLI handles AI interactions, TUI, and tool orchestration. SQL analysis is powered by the Rust-based `@altimateai/altimate-core` engine via napi-rs bindings (no Python required). Database connectivity uses native Node.js drivers with lazy loading. - -**No Python dependency**: All 73 tool methods run natively in TypeScript. No pip, venv, or Python installation needed. - -**dbt-first**: When working in a dbt project, the CLI automatically uses dbt's connection from `profiles.yml` — no separate warehouse configuration needed. - -### Monorepo structure - -``` -packages/ - altimate-code/ TypeScript CLI (main entry point) - drivers/ Shared database drivers (10 warehouses) - dbt-tools/ dbt integration (TypeScript) - plugin/ Plugin system - sdk/ SDKs (includes VS Code extension) - util/ Shared utilities -``` - ## Community & Contributing -- **Slack**: [altimate.ai/slack](https://altimate.ai/slack) — Real-time chat for questions, showcases, and feature discussion +- **Slack**: [Join Slack](https://altimate.studio/join-agentic-data-engineering-slack) — Real-time chat for questions, showcases, and feature discussion - **Issues**: [GitHub Issues](https://github.com/AltimateAI/altimate-code/issues) — Bug reports and feature requests - **Discussions**: [GitHub Discussions](https://github.com/AltimateAI/altimate-code/discussions) — Long-form questions and proposals - **Security**: See [SECURITY.md](./SECURITY.md) for responsible disclosure @@ -221,9 +182,10 @@ Contributions welcome — docs, SQL rules, warehouse connectors, and TUI improve ## Changelog +- **v0.5.0** (March 2026) — smooth streaming mode, builtin skills via postinstall, `/configure-claude` and `/configure-codex` commands, warehouse auth hardening +- **v0.4.9** (March 2026) — Snowflake auth overhaul (all auth methods), dbt tool regression fixes, parallel CI builds - **v0.4.2** (March 2026) — yolo mode, Python engine elimination (all-native TypeScript), tool consolidation, path sandboxing hardening, altimate-dbt CLI, unscoped npm package -- **v0.4.1** (March 2026) — env-based skill selection, session caching, tracing improvements -- **v0.4.0** (Feb 2026) — data visualization skill, 100+ tools, training system +- **v0.4.0** (March 2026) — data visualization skill, 100+ tools, training system - **v0.3.x** — [See full changelog →](CHANGELOG.md) ## License diff --git a/docs/docs/assets/css/extra.css b/docs/docs/assets/css/extra.css index 4a62c26c0..57f04e0ed 100644 --- a/docs/docs/assets/css/extra.css +++ b/docs/docs/assets/css/extra.css @@ -1,3 +1,13 @@ +/* --- Header: banner logo replaces site-name text --- */ +.md-header__button.md-logo img { + height: 1.6rem; + width: auto; +} + +.md-header__ellipsis > .md-header__topic:first-child { + display: none; +} + /* Make nav section headers more prominent */ .md-nav--primary > .md-nav__list > .md-nav__item--section > .md-nav__link { font-weight: 700; diff --git a/docs/docs/assets/images/altimate-code-banner-sml.png b/docs/docs/assets/images/altimate-code-banner-sml.png new file mode 100644 index 000000000..66a6c6ade Binary files /dev/null and b/docs/docs/assets/images/altimate-code-banner-sml.png differ diff --git a/docs/docs/getting-started/quickstart-new.md b/docs/docs/getting-started/quickstart-new.md index 44ecc3540..730556878 100644 --- a/docs/docs/getting-started/quickstart-new.md +++ b/docs/docs/getting-started/quickstart-new.md @@ -30,8 +30,6 @@ export ANTHROPIC_API_KEY=sk-ant-... altimate ``` -> **No API key?** Select **Codex** in `/connect` — it's built-in with no setup. - --- ## Step 3: Connect Your Warehouse diff --git a/docs/docs/getting-started/quickstart.md b/docs/docs/getting-started/quickstart.md index d4395cfc0..b0f15076c 100644 --- a/docs/docs/getting-started/quickstart.md +++ b/docs/docs/getting-started/quickstart.md @@ -4,7 +4,7 @@ description: "Install altimate-code, connect your warehouse and LLM, configure a # Setup -> **You need:** npm 8+ or Homebrew. An API key for any supported LLM provider, or use Codex (built-in, no key required). +> **You need:** npm 8+ or Homebrew. An API key for any supported LLM provider. --- @@ -49,8 +49,6 @@ Minimal config file option (`altimate-code.json` in your project root): } ``` -> **No API key?** Select **Codex** in the `/connect` menu. It's a built-in provider with no setup required. - ### Changing your LLM provider Switch providers at any time by updating the `provider` and `model` fields in `altimate-code.json`: diff --git a/docs/docs/index.md b/docs/docs/index.md index 63085ca92..19bff65f4 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -1,191 +1,10 @@ --- -title: altimate +title: altimate-code hide: - toc + - navigation --- - + -
- -

- altimate-code -

- -

The open-source data engineering harness.

- -

100+ tools for building, validating, optimizing, and shipping data products. Use in your terminal, CI pipeline, orchestration DAGs, or as the harness for your data agents. Evaluate across any platform, independent of a single warehouse provider.

- -

- -[Get Started](getting-started.md){ .md-button .md-button--primary } -[View on GitHub :material-github:](https://github.com/AltimateAI/altimate-code){ .md-button } - -

- -
- -
- -```bash -npm install -g altimate-code -``` - -
- ---- - -

Purpose-built for the data product lifecycle

-

Every tool covers a specific stage: build, validate, optimize, or ship. Not general-purpose AI on top of SQL files.

- -
- -- :material-database-search:{ .lg .middle } **SQL Anti-Pattern Detection** - - --- - - 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** - - --- - - Manifest parsing, test generation, model scaffolding, incremental model detection, and lineage-aware refactoring. - -
- ---- - -

Use anywhere in your stack

-

Run interactively, automate in CI, embed in DAGs, or mount as the tool layer for your AI agents.

- -
- -- :material-console:{ .lg .middle } **Terminal** - - --- - - Interactive TUI with 100+ tools, autocomplete for skills, and persistent memory across sessions. - -- :material-pipe-disconnected:{ .lg .middle } **CI Pipeline** - - --- - - Headless mode for automated validation, schema diffing, and anti-pattern checks in GitHub Actions or any CI system. - -- :material-graph:{ .lg .middle } **Orchestration DAGs** - - --- - - Call the harness from Airflow, Dagster, or Prefect tasks to add data quality gates and lineage checks to your pipelines. - -- :material-robot-outline:{ .lg .middle } **Data Agent Harness** - - --- - - Mount altimate as the tool layer underneath Claude Code, Codex, or any AI agent, giving it deterministic, warehouse-aware capabilities. - -
- ---- - -

Purpose-built agent modes

-

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. SQL writes prompt for approval. Destructive SQL is hard-blocked. - -- :material-chart-bar:{ .lg .middle } **Analyst** - - --- - - Explore data, run SELECT queries, and generate insights. Read-only access is enforced. SQL writes are denied, not prompted. Safe bash commands auto-allowed. - -- :material-clipboard-text:{ .lg .middle } **Plan** - - --- - - Plan before acting. Read-only with minimal permissions. No SQL, no bash, no file modifications. - -
- -Create custom agents with tailored permissions for specialized workflows like validation, migration, research, or executive reporting. See [Agent Configuration](configure/agents.md#custom-agents). - ---- - -

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

Evaluate across any platform

-

First-class support for 10 databases. Migrate, compare, and translate across platforms, not locked to one vendor.

- -
- -- :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** -- :material-database-outline: **Oracle** -- :material-database-search: **SQLite** - -
- ---- - - +Redirecting to [Getting Started](getting-started/index.md)... diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md index 273c5bec2..463f3f12d 100644 --- a/docs/docs/quickstart.md +++ b/docs/docs/quickstart.md @@ -4,7 +4,7 @@ description: "Install altimate-code and run your first SQL analysis. The open-so # Quickstart -> **You need:** npm 8+ or Homebrew. An API key for any supported LLM provider, or use Codex (built-in, no key required). +> **You need:** npm 8+ or Homebrew. An API key for any supported LLM provider. --- @@ -48,8 +48,6 @@ Minimal config file option (`altimate-code.json` in your project root): } ``` -> **No API key?** Select **Codex** in the `/connect` menu. It's a built-in provider with no setup required. - --- ## Step 3: Connect Your Warehouse _(Optional)_ diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 9a4635260..70daa5171 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -9,7 +9,7 @@ copyright: "© 2026 Altimate Inc. All rights reserved." theme: name: material custom_dir: docs/overrides - logo: assets/logo.png + logo: assets/images/altimate-code-banner-sml.png favicon: assets/images/favicon.png font: text: Inter