Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
22 changes: 21 additions & 1 deletion docs/claude-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,31 @@ helm install openab openab/openab \
--set agents.claude.discord.botToken="$DISCORD_BOT_TOKEN" \
--set-string 'agents.claude.discord.allowedChannels[0]=YOUR_CHANNEL_ID' \
--set agents.claude.command=claude-agent-acp \
--set agents.claude.workingDir=/home/node
--set agents.claude.workingDir=/home/node \
--set image.tag=beta
```

> Set `agents.kiro.enabled=false` to disable the default Kiro agent.

### Image Tag

Use `--set image.tag=<version>` to set the image version globally.
The chart auto-appends `-<agent>` to produce the final tag (see [image-tags.md](image-tags.md) for full details).

| Tag | Resolves to | Description |
|-----|-------------|-------------|
| `beta` | `beta-claude` | Floating beta channel (latest pre-release) |
| `0.9.0-beta.2` | `0.9.0-beta.2-claude` | Pinned to exact version |
| `0.9` | `0.9-claude` | Latest patch in minor (floating) |
| `stable` | `stable-claude` | Floating stable channel |

To override a single agent's image instead of the global tag:
```bash
--set agents.claude.image=ghcr.io/openabdev/openab:beta-claude
```

> ⚠️ There is no `latest` tag. Use `beta` or `stable`, or pin to an exact version.

## Manual config.toml

```toml
Expand Down
22 changes: 21 additions & 1 deletion docs/codex.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,31 @@ helm install openab openab/openab \
--set agents.codex.discord.botToken="$DISCORD_BOT_TOKEN" \
--set-string 'agents.codex.discord.allowedChannels[0]=YOUR_CHANNEL_ID' \
--set agents.codex.command=codex-acp \
--set agents.codex.workingDir=/home/node
--set agents.codex.workingDir=/home/node \
--set image.tag=beta
```

> Set `agents.kiro.enabled=false` to disable the default Kiro agent.

### Image Tag

Use `--set image.tag=<version>` to set the image version globally.
The chart auto-appends `-<agent>` to produce the final tag (see [image-tags.md](image-tags.md) for full details).

| Tag | Resolves to | Description |
|-----|-------------|-------------|
| `beta` | `beta-codex` | Floating beta channel (latest pre-release) |
| `0.9.0-beta.2` | `0.9.0-beta.2-codex` | Pinned to exact version |
| `0.9` | `0.9-codex` | Latest patch in minor (floating) |
| `stable` | `stable-codex` | Floating stable channel |

To override a single agent's image instead of the global tag:
```bash
--set agents.codex.image=ghcr.io/openabdev/openab:beta-codex
```

> ⚠️ There is no `latest` tag. Use `beta` or `stable`, or pin to an exact version.

## Manual config.toml

```toml
Expand Down
24 changes: 23 additions & 1 deletion docs/copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,31 @@ helm install openab-copilot openab/openab \
--set 'agents.copilot.args={--acp,--stdio}' \
--set agents.copilot.persistence.enabled=true \
--set agents.copilot.workingDir=/home/node \
--set 'agents.copilot.env.COPILOT_GITHUB_TOKEN=github_pat_YOUR_TOKEN_HERE' # optional, see Authentication
--set 'agents.copilot.env.COPILOT_GITHUB_TOKEN=github_pat_YOUR_TOKEN_HERE' \
--set image.tag=beta
```

> `COPILOT_GITHUB_TOKEN` is optional — see Authentication section below.
### Image Tag

Use `--set image.tag=<version>` to set the image version globally.
The chart auto-appends `-<agent>` to produce the final tag (see [image-tags.md](image-tags.md) for full details).

| Tag | Resolves to | Description |
|-----|-------------|-------------|
| `beta` | `beta-copilot` | Floating beta channel (latest pre-release) |
| `0.9.0-beta.2` | `0.9.0-beta.2-copilot` | Pinned to exact version |
| `0.9` | `0.9-copilot` | Latest patch in minor (floating) |
| `stable` | `stable-copilot` | Floating stable channel |

To override a single agent's image instead of the global tag:
```bash
--set agents.copilot.image=ghcr.io/openabdev/openab:beta-copilot
```

> ⚠️ There is no `latest` tag. Use `beta` or `stable`, or pin to an exact version.
## Model Selection

The default model is defined in `~/.copilot/settings.json`.
Expand Down
22 changes: 21 additions & 1 deletion docs/cursor.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,29 @@ helm install openab openab/openab \
--set agents.cursor.command=cursor-agent \
--set 'agents.cursor.args={acp}' \
--set agents.cursor.persistence.enabled=true \
--set agents.cursor.workingDir=/home/agent
--set agents.cursor.workingDir=/home/agent \
--set image.tag=beta
```

### Image Tag

Use `--set image.tag=<version>` to set the image version globally.
The chart auto-appends `-<agent>` to produce the final tag (see [image-tags.md](image-tags.md) for full details).

| Tag | Resolves to | Description |
|-----|-------------|-------------|
| `beta` | `beta-cursor` | Floating beta channel (latest pre-release) |
| `0.9.0-beta.2` | `0.9.0-beta.2-cursor` | Pinned to exact version |
| `0.9` | `0.9-cursor` | Latest patch in minor (floating) |
| `stable` | `stable-cursor` | Floating stable channel |

To override a single agent's image instead of the global tag:
```bash
--set agents.cursor.image=ghcr.io/openabdev/openab:beta-cursor
```

> ⚠️ There is no `latest` tag. Use `beta` or `stable`, or pin to an exact version.

## Model Selection

List available models:
Expand Down
22 changes: 21 additions & 1 deletion docs/gemini.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,33 @@ helm install openab openab/openab \
--set-string 'agents.gemini.discord.allowedChannels[0]=YOUR_CHANNEL_ID' \
--set agents.gemini.command=gemini \
--set agents.gemini.args='{--acp}' \
--set agents.gemini.workingDir=/home/node
--set agents.gemini.workingDir=/home/node \
--set image.tag=beta
```

> Set `agents.kiro.enabled=false` to disable the default Kiro agent.
>
> (Optional) `agents.gemini.args='{--acp}'` could be modified as `{--model,gemini-3-pro-preview,--acp}` if specific model is required. Otherwise, the default value will be 'Auto (Gemini 3)'.

### Image Tag

Use `--set image.tag=<version>` to set the image version globally.
The chart auto-appends `-<agent>` to produce the final tag (see [image-tags.md](image-tags.md) for full details).

| Tag | Resolves to | Description |
|-----|-------------|-------------|
| `beta` | `beta-gemini` | Floating beta channel (latest pre-release) |
| `0.9.0-beta.2` | `0.9.0-beta.2-gemini` | Pinned to exact version |
| `0.9` | `0.9-gemini` | Latest patch in minor (floating) |
| `stable` | `stable-gemini` | Floating stable channel |

To override a single agent's image instead of the global tag:
```bash
--set agents.gemini.image=ghcr.io/openabdev/openab:beta-gemini
```

> ⚠️ There is no `latest` tag. Use `beta` or `stable`, or pin to an exact version.

## Manual config.toml

```toml
Expand Down
22 changes: 21 additions & 1 deletion docs/grok.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,31 @@ helm install openab openab/openab \
--set agents.grok.command=grok \
--set-string 'agents.grok.args[0]=agent' \
--set-string 'agents.grok.args[1]=stdio' \
--set agents.grok.workingDir=/home/agent
--set agents.grok.workingDir=/home/agent \
--set image.tag=beta
```

> Set `agents.kiro.enabled=false` to disable the default Kiro agent.

### Image Tag

Use `--set image.tag=<version>` to set the image version globally.
The chart auto-appends `-<agent>` to produce the final tag (see [image-tags.md](image-tags.md) for full details).

| Tag | Resolves to | Description |
|-----|-------------|-------------|
| `beta` | `beta-grok` | Floating beta channel (latest pre-release) |
| `0.9.0-beta.2` | `0.9.0-beta.2-grok` | Pinned to exact version |
| `0.9` | `0.9-grok` | Latest patch in minor (floating) |
| `stable` | `stable-grok` | Floating stable channel |

To override a single agent's image instead of the global tag:
```bash
--set agents.grok.image=ghcr.io/openabdev/openab:beta-grok
```

> ⚠️ There is no `latest` tag. Use `beta` or `stable`, or pin to an exact version.

## Manual config.toml

```toml
Expand Down
22 changes: 21 additions & 1 deletion docs/hermes.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,31 @@ helm install openab openab/openab \
--set agents.hermes.discord.botToken="$DISCORD_BOT_TOKEN" \
--set-string 'agents.hermes.discord.allowedChannels[0]=YOUR_CHANNEL_ID' \
--set agents.hermes.command=hermes-acp \
--set agents.hermes.workingDir=/home/agent
--set agents.hermes.workingDir=/home/agent \
--set image.tag=beta
```

> Set `agents.kiro.enabled=false` to disable the default Kiro agent.

### Image Tag

Use `--set image.tag=<version>` to set the image version globally.
The chart auto-appends `-<agent>` to produce the final tag (see [image-tags.md](image-tags.md) for full details).

| Tag | Resolves to | Description |
|-----|-------------|-------------|
| `beta` | `beta-hermes` | Floating beta channel (latest pre-release) |
| `0.9.0-beta.2` | `0.9.0-beta.2-hermes` | Pinned to exact version |
| `0.9` | `0.9-hermes` | Latest patch in minor (floating) |
| `stable` | `stable-hermes` | Floating stable channel |

To override a single agent's image instead of the global tag:
```bash
--set agents.hermes.image=ghcr.io/openabdev/openab:beta-hermes
```

> ⚠️ There is no `latest` tag. Use `beta` or `stable`, or pin to an exact version.

## Manual config.toml

```toml
Expand Down
22 changes: 21 additions & 1 deletion docs/kiro.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,29 @@ helm repo update

helm install openab openab/openab \
--set agents.kiro.discord.botToken="$DISCORD_BOT_TOKEN" \
--set-string 'agents.kiro.discord.allowedChannels[0]=YOUR_CHANNEL_ID'
--set-string 'agents.kiro.discord.allowedChannels[0]=YOUR_CHANNEL_ID' \
--set image.tag=beta
```

### Image Tag

Use `--set image.tag=<version>` to set the image version globally.
The chart auto-appends `-<agent>` to produce the final tag (see [image-tags.md](image-tags.md) for full details).

| Tag | Resolves to | Description |
|-----|-------------|-------------|
| `beta` | `beta-kiro` | Floating beta channel (latest pre-release) |
| `0.9.0-beta.2` | `0.9.0-beta.2-kiro` | Pinned to exact version |
| `0.9` | `0.9-kiro` | Latest patch in minor (floating) |
| `stable` | `stable-kiro` | Floating stable channel |

To override a single agent's image instead of the global tag:
```bash
--set agents.kiro.image=ghcr.io/openabdev/openab:beta-kiro
```

> ⚠️ There is no `latest` tag. Use `beta` or `stable`, or pin to an exact version.

## Manual config.toml

```toml
Expand Down
22 changes: 21 additions & 1 deletion docs/opencode.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,31 @@ helm install openab openab/openab \
--set agents.opencode.discord.botToken="$DISCORD_BOT_TOKEN" \
--set-string 'agents.opencode.discord.allowedChannels[0]=YOUR_CHANNEL_ID' \
--set agents.opencode.workingDir=/home/node \
--set agents.opencode.pool.maxSessions=3
--set agents.opencode.pool.maxSessions=3 \
--set image.tag=beta
```

> Set `agents.kiro.enabled=false` to disable the default Kiro agent.

### Image Tag

Use `--set image.tag=<version>` to set the image version globally.
The chart auto-appends `-<agent>` to produce the final tag (see [image-tags.md](image-tags.md) for full details).

| Tag | Resolves to | Description |
|-----|-------------|-------------|
| `beta` | `beta-opencode` | Floating beta channel (latest pre-release) |
| `0.9.0-beta.2` | `0.9.0-beta.2-opencode` | Pinned to exact version |
| `0.9` | `0.9-opencode` | Latest patch in minor (floating) |
| `stable` | `stable-opencode` | Floating stable channel |

To override a single agent's image instead of the global tag:
```bash
--set agents.opencode.image=ghcr.io/openabdev/openab:beta-opencode
```

> ⚠️ There is no `latest` tag. Use `beta` or `stable`, or pin to an exact version.

## Manual config.toml

```toml
Expand Down
Loading