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
258 changes: 117 additions & 141 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ This document is the reference for the visible slash commands available in Coven
1. [Command System Overview](#command-system-overview)
2. [Session & Navigation](#session--navigation)
3. [Model & Provider](#model--provider) — `/model`, `/providers`, `/connect`, `/thinking`, `/effort`, `/advisor`, `/fast`
4. [Configuration & Settings](#configuration--settings) — `/config`, `/keybindings`, `/permissions`, `/hooks`, `/mcp`, `/output-style`, `/theme`, `/statusline`, `/vim`, `/voice`, `/terminal-setup`
5. [Code & Git](#code--git) — `/commit`, `/diff`, `/undo`, `/revert`, `/review`, `/init`, `/search`
6. [Search & Files](#search--files) — `/context`
7. [Memory & Context](#memory--context) — `/memory`, `/usage`, `/cost`, `/status`
4. [Configuration & Settings](#configuration--settings) — `/config`, `/keybindings`, `/permissions`, `/hooks`, `/mcp`, `/output-style`, `/theme`
5. [Code & Git](#code--git) — `/commit`, `/diff`, `/review`, `/init`, `/search`
6. [Search & Files](#search--files)
7. [Memory & Context](#memory--context) — `/memory`, `/usage`, `/stats`, `/status`
8. [Agents & Tasks](#agents--tasks) — `/agents`, `/tasks`, `/goal`, `/managed-agents`, `/agent`
9. [Planning & Review](#planning--review) — `/plan`, `ultraplan` (CLI)
10. [MCP & Integrations](#mcp--integrations) — `/mcp`, `/skills`, `/plugin`, `/chrome`
11. [Authentication](#authentication) — `/login`, `/logout`, `/switch`, `/refresh`
12. [Display & Terminal](#display--terminal) — `/theme`, `/output-style`, `/statusline`, `/vim`, `/terminal-setup`, `/incant`, `/color`
12. [Display & Terminal](#display--terminal) — `/theme`, `/output-style`, `/incant`
13. [Diagnostics & Info](#diagnostics--info) — `/doctor`, `/version`, `/update`
14. [Export & Sharing](#export--sharing) — `/export`, `/copy`, `/share`
15. [Advanced & Internal](#advanced--internal) — `/thinking`, `/connect`, `/fork`, `/effort`, `/whisper`, `/sandbox`, `/think-back`
Expand Down Expand Up @@ -125,14 +125,16 @@ Fork the current session into a new independent session that begins from the cur

### /rewind

Rewind the conversation to a previous message. Displays a numbered list of messages; enter a number to truncate history to that point and resume from there.

```
/rewind
/rewind <message-index>
```

---
Rewind the conversation to a previous message. Displays a numbered list of messages; enter a number to truncate history to that point and resume from there.

```
/rewind
/rewind <message-index>
```

`/undo` and `/revert` remain available as hidden compatibility commands for one release, but new docs and command discovery route history work through `/rewind`.

---

### /compact

Expand Down Expand Up @@ -358,54 +360,51 @@ Open the interactive theme picker. Preview and select a color theme for the Cove

---

### /statusline

Configure the status line displayed at the bottom of the TUI. Toggle individual elements such as model name, token count, session name, and git branch.

```
/statusline
/statusline toggle model
/statusline toggle tokens
```

---

### /vim
**Aliases:** `vi`

Toggle vim keybinding mode on or off. In vim mode the input field behaves like a vim editor (normal/insert/visual modes). Persisted to config.

```
/vim
/vim on
/vim off
```

---

### /voice

Configure voice input/output. Requires a supported audio backend. Subcommands control microphone selection, TTS voice, and push-to-talk behavior.

```
/voice
/voice on
/voice off
/voice mic <device>
/voice tts <voice-name>
```

---

### /terminal-setup

Run the terminal capability detection and setup wizard. Checks for true-color support, font ligatures, Unicode rendering, and configures Coven Code accordingly.

```
/terminal-setup
```

---
### /config statusline

Configure the status line displayed at the bottom of the TUI. Toggle individual elements such as model name, token count, session name, and git branch.

```
/config statusline
/config statusline show model
/config statusline hide tokens
```

---

### /config vim

Toggle vim keybinding mode on or off. In vim mode the input field behaves like a vim editor (normal/insert/visual modes). Persisted to config.
Comment on lines +375 to +377

```
/config vim
/config vim on
/config vim off
```

---

### /config voice

Configure voice input/output. Requires a supported audio backend. Subcommands control microphone selection, TTS voice, and push-to-talk behavior.

Comment on lines +389 to +390
```
/config voice status
/config voice on
/config voice off
```

---

### /config terminal-setup

Run the terminal capability detection and setup wizard. Checks for true-color support, font ligatures, Unicode rendering, and configures Coven Code accordingly.

```
/config terminal-setup
```

---

## Code & Git

Expand All @@ -431,32 +430,7 @@ Show file diffs for changes made during the current session. Displays a unified

---

### /undo

Undo file changes made during the current session. Restores files to their state before Coven Code's last write operation. Can be called multiple times to step further back.

```
/undo
/undo <file-path>
```

---

### /revert

Revert file changes from an assistant turn back to their pre-turn state, using the shadow-git snapshot. `/undo` reverts the most recent edit; `/revert` reverts a chosen turn and removes that turn (and any later turns) from the session transcript.

```
/revert — revert the most recent assistant turn
/revert 2 — revert the second-to-last turn
/revert abc123 — revert the turn whose message id starts with 'abc123'
/revert list — list turns that have recorded file changes
/revert diff [n] — preview the shadow-git diff for a turn without reverting
```

---

### /review
### /review

Review code changes via the model and optionally post the review to the associated GitHub PR. Runs `git diff <base>...HEAD` (or `git diff --cached` when no base is given) and sends the diff for a structured review.

Expand Down Expand Up @@ -505,13 +479,13 @@ Search the codebase using natural language or regex patterns. Wraps the GrepTool

## Search & Files

### /context
Analyze context window usage. Shows a breakdown of tokens consumed by system prompt, conversation history, file contents, and tool results. Helps identify what to compact or drop.
```
/context
```
### /usage context

Analyze context window usage. Shows a breakdown of tokens consumed by system prompt, conversation history, file contents, and tool results. Helps identify what to compact or drop.

```
/usage context
```

---

Expand All @@ -533,21 +507,23 @@ Manage session memory. Memory entries are short notes persisted across sessions.

### /usage

Display a detailed token usage breakdown for the current session. Shows input tokens, output tokens, cache reads, cache writes, and estimated cost per API call.

```
/usage
```

---

### /cost

Show the total token usage and estimated cost for the current session. Provides a quick summary without the per-call breakdown of `/usage`. In the TUI, `/cost` opens the interactive stats dialog.

```
/cost
```
Display a detailed token usage breakdown for the current session. Shows input tokens, output tokens, cache reads, cache writes, and estimated cost per API call.

```
/usage
/usage cost
/usage context
```

---

### /usage cost

Show the total token usage and estimated cost for the current session. Provides a quick summary without the full account/quota context of `/usage`. In the TUI, `/stats` opens the interactive stats dialog.

```
/usage cost
```

For aggregate token / cost / tool statistics across saved sessions, use the `stats` CLI command: `coven-code stats [summary|sessions|tools|daily|session <id>]`.

Expand Down Expand Up @@ -837,21 +813,21 @@ Documented above under [Configuration & Settings](#configuration--settings).

---

### /statusline
Documented above under [Configuration & Settings](#configuration--settings).
---
### /vim
Documented above under [Configuration & Settings](#configuration--settings).
---
### /terminal-setup
Documented above under [Configuration & Settings](#configuration--settings).
### /config statusline

Documented above under [Configuration & Settings](#configuration--settings).

---

### /config vim

Documented above under [Configuration & Settings](#configuration--settings).

---

### /config terminal-setup

Documented above under [Configuration & Settings](#configuration--settings).

---

Expand Down Expand Up @@ -887,16 +863,16 @@ Intensity:

---

### /color
Set the prompt bar color for the current session. Accepts standard color names or hex values. The color resets when the session ends unless saved via `/config`.
```
/color — open the interactive color picker
/color <name> — set to a named color (e.g., blue, red, green)
/color #ff6b6b — set to a hex color value
/color default — reset to the theme default
```
### /config color

Set the prompt bar color for the current session. Accepts standard color names or hex values. The color resets when the session ends unless saved via `/config`.

Comment on lines +866 to +869
```
/config color — show the current prompt color
/config color <name> — set to a named color (e.g., blue, red, green)
/config color #ff6b6b — set to a hex color value
/config color default — reset to the theme default
```

---

Expand Down Expand Up @@ -1001,9 +977,9 @@ Documented above under [Model & Provider](#model--provider).

---

### /context
Documented above under [Search & Files](#search--files).
### /usage context

Documented above under [Search & Files](#search--files).

---

Expand Down Expand Up @@ -1226,7 +1202,7 @@ adapters (`/agents`, `/add-dir`, `/branch`, `/tag`, `/ide`,
| `ide` | Manage IDE integrations. |
| `pr-comments` | Get comments from a GitHub PR. |
| `ultraplan` | Launch the Ultraplan agentic code planner with extended thinking. |
| `stats` | Aggregate token / cost / tool stats across saved sessions (in the TUI, `/cost` opens the stats dialog). |
| `stats` | Aggregate token / cost / tool stats across saved sessions (in the TUI, `/stats` opens the stats dialog). |

---

Expand All @@ -1238,13 +1214,13 @@ Not all commands are available in all contexts.

When running with `--remote`, only a restricted set of commands is available:

`session`, `exit`, `clear`, `help`, `theme`, `vim`, `cost`, `usage`, `plan`, `keybindings`, `statusline`
`session`, `exit`, `clear`, `help`, `theme`, `config`, `usage`, `plan`, `keybindings`

### Bridge Mode

Over the Remote Control bridge (used by IDE integrations), only `local`-type commands are forwarded:

`compact`, `clear`, `cost`
`compact`, `clear`, `usage`

### Availability-Restricted Commands

Expand All @@ -1254,5 +1230,5 @@ Some commands are available only under certain account or platform conditions:
|---------|-------------|
| `/fast` | Available when a fast-mode model is configured for the active provider |
| `/sandbox` | Functional on macOS, Linux, WSL2 only; no-op on native Windows |
| `/voice` | Requires an audio backend plus `OPENAI_API_KEY` or `WHISPER_ENDPOINT_URL` for transcription |
| `/config voice` | Requires an audio backend plus `OPENAI_API_KEY` or `WHISPER_ENDPOINT_URL` for transcription |
| `/chrome` | Requires a running Chrome/Chromium instance launched with remote debugging enabled |
16 changes: 8 additions & 8 deletions docs/src/demos.js
Original file line number Diff line number Diff line change
Expand Up @@ -244,28 +244,29 @@ export function registerDemos(Alpine) {
{ id: '/advisor', category: 'Model', desc: 'Set a secondary advisor model' },
{ id: '/fast', category: 'Model', desc: 'Toggle fast mode (smaller, faster model)' },
// Config
{ id: '/config', category: 'Config', desc: 'Open the settings editor' },
{ id: '/config', category: 'Config', desc: 'Open settings or adjust UI config' },
{ id: '/config color', category: 'Config', desc: 'Set the prompt bar color' },
{ id: '/config statusline', category: 'Config', desc: 'Configure status line' },
{ id: '/config vim', category: 'Config', desc: 'Toggle vim mode' },
{ id: '/config voice', category: 'Config', desc: 'Voice input mode' },
{ id: '/config terminal-setup', category: 'Config', desc: 'Run terminal capability checks' },
{ id: '/keybindings', category: 'Config', desc: 'Open the interactive keybinding editor' },
{ id: '/permissions', category: 'Config', desc: 'Manage tool permission rules' },
{ id: '/hooks', category: 'Config', desc: 'Inspect active hooks' },
{ id: '/mcp', category: 'Config', desc: 'Manage MCP servers' },
{ id: '/output-style', category: 'Config', desc: 'Switch output style' },
{ id: '/theme', category: 'Config', desc: 'Switch visual theme' },
{ id: '/statusline', category: 'Config', desc: 'Configure status line' },
{ id: '/vim', category: 'Config', desc: 'Toggle vim mode' },
{ id: '/voice', category: 'Config', desc: 'Voice input mode' },
// Code & Git
{ id: '/commit', category: 'Code & Git', desc: 'Stage and commit current changes', keywords: 'git' },
{ id: '/diff', category: 'Code & Git', desc: 'Show working-tree diff', keywords: 'git' },
{ id: '/undo', category: 'Code & Git', desc: 'Undo the last file edit (uses snapshot)' },
{ id: '/review', category: 'Code & Git', desc: 'Review a PR or current changes' },
{ id: '/security-review', category: 'Code & Git', desc: 'Security audit of pending changes' },
{ id: '/init', category: 'Code & Git', desc: 'Initialise a new AGENTS.md for the project' },
{ id: '/search', category: 'Code & Git', desc: 'Codebase search', keywords: 'grep find' },
// Memory & Cost
{ id: '/memory', category: 'Memory & Cost', desc: 'Browse persistent memory entries' },
{ id: '/context', category: 'Memory & Cost', desc: 'Show context window usage' },
{ id: '/cost', category: 'Memory & Cost', desc: 'Token usage and dollar cost for the session', keywords: 'tokens money' },
{ id: '/usage context', category: 'Memory & Cost', desc: 'Show context window usage' },
{ id: '/usage cost', category: 'Memory & Cost', desc: 'Token usage and dollar cost for the session', keywords: 'tokens money' },
{ id: '/usage', category: 'Memory & Cost', desc: 'Session usage statistics' },
{ id: '/stats', category: 'Memory & Cost', desc: 'Session statistics' },
{ id: '/insights', category: 'Memory & Cost', desc: 'Session statistics and tool usage report' },
Expand All @@ -290,7 +291,6 @@ export function registerDemos(Alpine) {
{ id: '/rocky', category: 'Display', desc: 'Rocky (Project Hail Mary) speech mode' },
{ id: '/normal', category: 'Display', desc: 'Deactivate speech modes' },
{ id: '/mobile', category: 'Display', desc: 'Compact mobile-friendly rendering' },
{ id: '/color', category: 'Display', desc: 'Adjust colour palette at runtime' },
{ id: '/stickers', category: 'Display', desc: 'Toggle sticker rendering' },
// Coven
{ id: '/coven', category: 'Coven', desc: 'Substrate surface: kill, log, send, familiars, etc.' },
Expand Down
Loading