Skip to content

Commit c061dda

Browse files
Saravclaude
Sarav
and
claude
committed
docs: initial sync from help-docs (source of truth)
Generated by help-docs tools/sync_to_oss.py. Edit docs in help-docs, not here. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent b18bbf3 commit c061dda

75 files changed

Lines changed: 1224 additions & 424 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/docs/configure/acp.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
<!--
2+
DO NOT EDIT HERE. This file is a generated copy.
3+
Source of truth: AltimateAI/help-docs (docs/code/).
4+
Edits should be made in help-docs; they are synced here automatically.
5+
-->
6+
---
7+
title: ACP (Agent Communication Protocol) Support
8+
description: "Use Altimate Code with the Agent Communication Protocol (ACP) for interoperability with other AI agents and editor integrations.
9+
"
10+
---
11+
112
# ACP Support
213

314
altimate implements the Agent Communication Protocol (ACP), allowing it to act as a backend for editors and IDEs.

‎docs/docs/configure/agents.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
<!--
2+
DO NOT EDIT HERE. This file is a generated copy.
3+
Source of truth: AltimateAI/help-docs (docs/code/).
4+
Edits should be made in help-docs; they are synced here automatically.
5+
-->
6+
---
7+
title: Agent Modes — Builder, Analyst, Plan
8+
description: "Altimate Code ships three AI agent personas — Builder, Analyst, and Plan — each with different tool access levels and use cases.
9+
"
10+
---
11+
112
# Agents
213

314
Agents define different AI personas with specific models, prompts, permissions, and capabilities.
@@ -95,7 +106,8 @@ Create agents as markdown files in `.altimate-code/agents/`:
95106
---
96107
name: cost-reviewer
97108
model: anthropic/claude-sonnet-4-6
98-
description: Reviews queries for cost efficiency
109+
description: "Reviews queries for cost efficiency
110+
"
99111
---
100112

101113
You are a Snowflake cost optimization expert. For every query:

‎docs/docs/configure/bedrock-custom-endpoints.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
<!--
2+
DO NOT EDIT HERE. This file is a generated copy.
3+
Source of truth: AltimateAI/help-docs (docs/code/).
4+
Edits should be made in help-docs; they are synced here automatically.
5+
-->
6+
---
7+
title: Amazon Bedrock Custom Endpoints — Altimate Code
8+
description: "Configure Altimate Code to use a custom Amazon Bedrock endpoint, API gateway, or proxy for your LLM calls.
9+
"
10+
---
11+
112
# Amazon Bedrock Custom Endpoints
213

314
This guide covers using Altimate Code with a custom Amazon Bedrock endpoint — such as a corporate API gateway, reverse proxy, or VPC endpoint that sits in front of Bedrock.

‎docs/docs/configure/commands.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
<!--
2+
DO NOT EDIT HERE. This file is a generated copy.
3+
Source of truth: AltimateAI/help-docs (docs/code/).
4+
Edits should be made in help-docs; they are synced here automatically.
5+
-->
6+
---
7+
title: Built-in Slash Commands — Altimate Code
8+
description: "Reference for all built-in slash commands in Altimate Code: /init, /discover, /review, /feedback, /configure-claude, and /configure-codex.
9+
"
10+
---
11+
112
# Commands
213

314
## Built-in Commands
@@ -95,7 +106,8 @@ Create markdown files in `.altimate-code/commands/`:
95106
```markdown
96107
---
97108
name: review
98-
description: Review SQL for anti-patterns and best practices
109+
description: "Review SQL for anti-patterns and best practices
110+
"
99111
---
100112

101113
Review the following SQL file for:

‎docs/docs/configure/config.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
<!--
2+
DO NOT EDIT HERE. This file is a generated copy.
3+
Source of truth: AltimateAI/help-docs (docs/code/).
4+
Edits should be made in help-docs; they are synced here automatically.
5+
-->
6+
---
7+
title: Config File Reference — Altimate Code
8+
description: "JSON and JSONC configuration file locations, priority order, and all available settings for Altimate Code.
9+
"
10+
---
11+
112
# Configuration
213

314
altimate uses JSON (or JSONC) configuration files. The config file is named `altimate-code.json` or `altimate-code.jsonc`.

‎docs/docs/configure/context-management.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
<!--
2+
DO NOT EDIT HERE. This file is a generated copy.
3+
Source of truth: AltimateAI/help-docs (docs/code/).
4+
Edits should be made in help-docs; they are synced here automatically.
5+
-->
6+
---
7+
title: Context Management — Altimate Code
8+
description: "How Altimate Code automatically manages conversation context to stay within model limits using pruning and compacting.
9+
"
10+
---
11+
112
# Context Management
213

314
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.

‎docs/docs/configure/custom-tools.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
<!--
2+
DO NOT EDIT HERE. This file is a generated copy.
3+
Source of truth: AltimateAI/help-docs (docs/code/).
4+
Edits should be made in help-docs; they are synced here automatically.
5+
-->
6+
---
7+
title: Custom Tools (TypeScript Plugins) — Altimate Code
8+
description: "Extend Altimate Code with custom TypeScript plugins. Quick start guide for building and registering your own tools.
9+
"
10+
---
11+
112
# Custom Tools
213

314
Create custom tools using TypeScript and the altimate plugin system.

‎docs/docs/configure/formatters.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
<!--
2+
DO NOT EDIT HERE. This file is a generated copy.
3+
Source of truth: AltimateAI/help-docs (docs/code/).
4+
Edits should be made in help-docs; they are synced here automatically.
5+
-->
6+
---
7+
title: Formatters — Altimate Code
8+
description: "Altimate Code auto-formats files after editing using language-specific formatters. See the full list of supported languages.
9+
"
10+
---
11+
112
# Formatters
213

314
altimate auto-formats files after editing using language-specific formatters.

‎docs/docs/configure/governance.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
<!--
2+
DO NOT EDIT HERE. This file is a generated copy.
3+
Source of truth: AltimateAI/help-docs (docs/code/).
4+
Edits should be made in help-docs; they are synced here automatically.
5+
-->
6+
---
7+
title: Governance & Permissions — Altimate Code
8+
description: "Task-scoped permissions and deterministic tool guards that keep Altimate Code safe in production data environments.
9+
"
10+
---
11+
112
# Governance
213

314
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.

‎docs/docs/configure/index.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
<!--
2+
DO NOT EDIT HERE. This file is a generated copy.
3+
Source of truth: AltimateAI/help-docs (docs/code/).
4+
Edits should be made in help-docs; they are synced here automatically.
5+
-->
6+
---
7+
title: Configure Altimate Code
8+
description: "Configure warehouses, LLM providers, agent modes, and preferences in Altimate Code.
9+
"
10+
---
11+
112
# Configure
213

314
Set up your warehouses, LLM providers, and preferences. For agents, tools, skills, and commands, see the [Use](../data-engineering/agent-modes.md) section. For rules, permissions, and context management, see [Governance](rules.md).

0 commit comments

Comments
 (0)