Skip to content

Commit 56b413a

Browse files
Saurabh Aroraclaude
andcommitted
docs: sync agent modes from PR #282, Claude/Codex commands from #235, stub web UI
- Reduce agent modes from 7 to 3 (builder, analyst, plan) per PR #282 - Add SQL Write Access Control section with query classification table - Add sql_execute_write permission to permissions reference - Update /data to /altimate in Claude Code guide, add /configure-claude setup - Add Codex CLI skill integration and /configure-codex setup - Add /configure-claude and /configure-codex to commands reference - Stub web UI page with Coming Soon notice - Update all cross-references (getting-started, quickstart, index, tui, training, migration) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent ebdf138 commit 56b413a

14 files changed

Lines changed: 181 additions & 367 deletions

File tree

docs/docs/configure/agents.md

Lines changed: 41 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,46 @@ Agents define different AI personas with specific models, prompts, permissions,
44

55
## Built-in Agents
66

7-
### General Purpose
7+
| Agent | Description | Access Level |
8+
|-------|------------|-------------|
9+
| `builder` | Create and modify dbt models, SQL pipelines, and data transformations | Full read/write. SQL mutations prompt for approval. |
10+
| `analyst` | Explore data, run SELECT queries, inspect schemas, generate insights | Read-only (enforced). SQL writes denied. Safe bash commands auto-allowed. |
11+
| `plan` | Plan before acting, restricted to planning files only | Minimal: no edits, no bash, no SQL |
812

9-
| Agent | Description |
10-
|-------|------------|
11-
| `general` | Default general-purpose coding agent |
12-
| `plan` | Planning agent that analyzes before acting |
13-
| `build` | Build-focused agent that prioritizes code generation |
14-
| `explore` | Read-only exploration agent |
13+
### Builder
1514

16-
### Data Engineering
15+
Full access mode. Can read/write files, run any bash command (with approval), execute SQL, and modify dbt models. SQL write operations (`INSERT`, `UPDATE`, `DELETE`, `CREATE`, etc.) prompt for user approval. Destructive SQL (`DROP DATABASE`, `DROP SCHEMA`, `TRUNCATE`) is hard-blocked.
1716

18-
| Agent | Description | Permissions |
19-
|-------|------------|------------|
20-
| `builder` | Create dbt models, SQL pipelines, transformations | Full read/write |
21-
| `analyst` | Explore data, run SELECT queries, generate insights | Read-only (enforced) |
22-
| `validator` | Data quality checks, schema validation, test coverage | Read + validate |
23-
| `migrator` | Cross-warehouse SQL translation and migration | Read/write for migration |
17+
### Analyst
18+
19+
Truly read-only mode for safe data exploration:
20+
21+
- **File access**: Read, grep, glob without prompts
22+
- **SQL**: SELECT queries execute freely. Write queries are denied (not prompted, blocked entirely)
23+
- **Bash**: Safe commands auto-allowed (`ls`, `grep`, `cat`, `head`, `tail`, `find`, `wc`). dbt read commands allowed (`dbt list`, `dbt ls`, `dbt debug`, `dbt deps`). Everything else denied.
24+
- **Web**: Fetch and search allowed without prompts
25+
- **Schema/warehouse/finops**: All inspection tools available
2426

2527
!!! tip
26-
Use the `analyst` agent when exploring data to ensure no accidental writes. Switch to `builder` when you are ready to create or modify models.
28+
Use `analyst` when exploring data to ensure no accidental writes. Switch to `builder` when you're ready to create or modify models.
29+
30+
### Plan
31+
32+
Planning mode with minimal permissions. Can only read files and edit plan files. No SQL, no bash, no file modifications.
33+
34+
## SQL Write Access Control
35+
36+
All SQL queries are classified before execution:
37+
38+
| Query Type | Builder | Analyst |
39+
|-----------|---------|---------|
40+
| `SELECT`, `SHOW`, `DESCRIBE`, `EXPLAIN` | Allowed | Allowed |
41+
| `INSERT`, `UPDATE`, `DELETE`, `CREATE`, `ALTER` | Prompts for approval | Denied |
42+
| `DROP DATABASE`, `DROP SCHEMA`, `TRUNCATE` | Blocked (cannot override) | Blocked |
43+
44+
The classifier detects write operations including: `INSERT`, `UPDATE`, `DELETE`, `MERGE`, `CREATE`, `DROP`, `ALTER`, `TRUNCATE`, `GRANT`, `REVOKE`, `COPY INTO`, `CALL`, `EXEC`, `EXECUTE IMMEDIATE`, `BEGIN`, `DECLARE`, `REPLACE`, `UPSERT`, `RENAME`.
45+
46+
Multi-statement queries (`SELECT 1; INSERT INTO ...`) are classified as write if any statement is a write.
2747

2848
## Custom Agents
2949

@@ -86,11 +106,11 @@ You are a Snowflake cost optimization expert. For every query:
86106
```
87107

88108
!!! info
89-
Markdown agent files use YAML frontmatter for configuration and the body as the system prompt. This is a convenient way to define agents without editing your main config file.
109+
Markdown agent files use YAML frontmatter for configuration and the body as the system prompt.
90110

91111
## Agent Permissions
92112

93-
Each agent can have its own permission overrides that restrict or expand the default permissions:
113+
Each agent can have its own permission overrides:
94114

95115
```json
96116
{
@@ -99,10 +119,11 @@ Each agent can have its own permission overrides that restrict or expand the def
99119
"permission": {
100120
"write": "deny",
101121
"edit": "deny",
122+
"sql_execute_write": "deny",
102123
"bash": {
103-
"dbt show *": "allow",
124+
"*": "deny",
104125
"dbt list *": "allow",
105-
"*": "deny"
126+
"ls *": "allow"
106127
}
107128
}
108129
}
@@ -117,4 +138,4 @@ Each agent can have its own permission overrides that restrict or expand the def
117138

118139
- **TUI**: Press leader + `a` or use `/agent <name>`
119140
- **CLI**: `altimate --agent analyst`
120-
- **In conversation**: Type `/agent validator`
141+
- **In conversation**: Type `/agent analyst`

docs/docs/configure/commands.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22

33
## Built-in Commands
44

5-
altimate ships with four built-in slash commands:
5+
altimate ships with six built-in slash commands:
66

77
| Command | Description |
88
|---------|-------------|
99
| `/init` | Create or update an AGENTS.md file with build commands and code style guidelines. |
1010
| `/discover` | Scan your data stack and set up warehouse connections. Detects dbt projects, warehouse connections from profiles/Docker/env vars, installed tools, and config files. Walks you through adding and testing new connections, then indexes schemas. |
1111
| `/review` | Review changes. Accepts `commit`, `branch`, or `pr` as an argument (defaults to uncommitted changes). |
1212
| `/feedback` | Submit product feedback as a GitHub issue. Guides you through title, category, description, and optional session context. |
13+
| `/configure-claude` | Configure altimate as a `/altimate` slash command in [Claude Code](https://claude.com/claude-code). Writes `~/.claude/commands/altimate.md` so you can invoke altimate from within Claude Code sessions. |
14+
| `/configure-codex` | Configure altimate as a skill in [Codex CLI](https://developers.openai.com/codex). Creates `~/.codex/skills/altimate/SKILL.md` so Codex can delegate data engineering tasks to altimate. |
1315

1416
### `/discover`
1517

@@ -47,6 +49,31 @@ Submit product feedback directly from the CLI. The agent walks you through:
4749

4850
Requires the `gh` CLI to be installed and authenticated (`gh auth login`).
4951

52+
### `/configure-claude`
53+
54+
Set up altimate as a tool inside Claude Code:
55+
56+
```
57+
/configure-claude
58+
```
59+
60+
This creates `~/.claude/commands/altimate.md`, which registers a `/altimate` slash command in Claude Code. After running this, you can use `/altimate` in any Claude Code session to delegate data engineering tasks:
61+
62+
```
63+
# In Claude Code
64+
/altimate analyze the cost of our top 10 most expensive queries
65+
```
66+
67+
### `/configure-codex`
68+
69+
Set up altimate as a skill inside Codex CLI:
70+
71+
```
72+
/configure-codex
73+
```
74+
75+
This creates `~/.codex/skills/altimate/SKILL.md`. Restart Codex after running this command. Codex will then automatically invoke altimate when you ask about data engineering tasks.
76+
5077
## Custom Commands
5178

5279
Custom commands let you define reusable slash commands.
@@ -109,3 +136,14 @@ Commands are loaded from:
109136
2. `~/.config/altimate-code/commands/` globally
110137

111138
Press leader + `/` to see all available commands.
139+
140+
## External CLI Integration
141+
142+
The `/configure-claude` and `/configure-codex` commands write integration files to external CLI tools:
143+
144+
| Command | File created | Purpose |
145+
|---------|-------------|---------|
146+
| `/configure-claude` | `~/.claude/commands/altimate.md` | Registers `/altimate` slash command in Claude Code |
147+
| `/configure-codex` | `~/.codex/skills/altimate/SKILL.md` | Registers altimate as a Codex CLI skill |
148+
149+
These files allow you to invoke altimate's data engineering capabilities from within other AI coding agents.

docs/docs/configure/permissions.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ Override permissions for specific agents:
8686
| `grep` | Yes | Search files |
8787
| `list` | Yes | List directories |
8888
| `bash` | Yes | Shell commands |
89+
| `sql_execute_write` | Yes | SQL write operations (INSERT, UPDATE, DELETE, etc.) |
8990
| `task` | Yes | Spawn subagents |
9091
| `lsp` | Yes | LSP operations |
9192
| `skill` | Yes | Execute skills |
@@ -205,20 +206,22 @@ Give each agent only the permissions it needs:
205206
"permission": {
206207
"write": "deny",
207208
"edit": "deny",
209+
"sql_execute_write": "deny",
208210
"bash": {
209-
"SELECT *": "allow",
210-
"dbt docs *": "allow",
211-
"*": "deny"
211+
"*": "deny",
212+
"ls *": "allow",
213+
"cat *": "allow",
214+
"dbt list *": "allow"
212215
}
213216
}
214217
},
215218
"builder": {
216219
"permission": {
220+
"sql_execute_write": "ask",
217221
"bash": {
218222
"*": "ask",
219223
"dbt *": "allow",
220-
"git *": "ask",
221-
"DROP *": "deny"
224+
"rm -rf *": "deny"
222225
}
223226
}
224227
}

0 commit comments

Comments
 (0)