Skip to content

Commit 45cf10e

Browse files
sacenoxsacenox
committed
docs: sync gh-pages docs
1 parent bb5dd9e commit 45cf10e

3 files changed

Lines changed: 103 additions & 86 deletions

File tree

‎README.md‎

Lines changed: 31 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -59,32 +59,34 @@ Plugins can add more tools, but the core stays intentionally small.
5959

6060
## Commands
6161

62-
| Command | Description |
63-
| ------------ | ---------------------------------------------------------------------- |
64-
| `/model` | Switch models. Persists as the global default. |
65-
| `/session` | List and resume sessions scoped to the current working directory. |
66-
| `/new` | Start a fresh session and reset cumulative usage counters. |
67-
| `/fork` | Copy the conversation into a new session and continue independently. |
68-
| `/undo` | Remove the last conversational turn (does not revert file changes). |
69-
| `/reasoning` | Toggle thinking visibility. Persisted and restored on launch. |
70-
| `/verbose` | Toggle verbose shell rendering plus edit previews/errors in the log. |
71-
| `/login` | Interactive OAuth login for supported providers. |
72-
| `/logout` | Clear saved OAuth credentials for a logged-in provider. |
73-
| `/effort` | Set reasoning effort: low, medium, high, or xhigh. |
74-
| `/help` | List commands, loaded AGENTS.md files, discovered skills, and plugins. |
62+
| Command | Description |
63+
| ------------ | ------------------------------------------------------------------------------------------------------ |
64+
| `/model` | Switch models and save the choice as the global default. |
65+
| `/session` | Open the session picker for the current working directory. |
66+
| `/new` | Start a fresh session and reset the running token and cost totals. |
67+
| `/fork` | Fork the current chat into a new session, keep the original, and add a UI-only `Forked session.` note. |
68+
| `/undo` | Remove the last conversational turn without touching filesystem changes. |
69+
| `/reasoning` | Show or hide model thinking. The setting is saved and restored on launch. |
70+
| `/verbose` | Expand shell output plus edit previews and edit errors in the conversation log. |
71+
| `/login` | Sign in with a supported OAuth provider. |
72+
| `/logout` | Remove saved OAuth credentials for a logged-in provider. |
73+
| `/effort` | Choose low, medium, high, or xhigh reasoning effort. |
74+
| `/help` | Show commands, current toggles, loaded AGENTS.md files, skills, and plugins. |
7575

7676
## Key bindings
7777

78-
| Key | Action |
79-
| ------------- | ------------------------------------------------- |
80-
| `Enter` | Submit message |
81-
| `Shift+Enter` | Insert newline |
82-
| `Escape` | Interrupt current turn, preserve partial response |
83-
| `Tab` | File path autocomplete (or command filter on `/`) |
84-
| `Ctrl+R` | Search global raw input history |
85-
| `Ctrl+C` | Graceful exit |
86-
| `Ctrl+D` | Graceful exit (EOF, when input is empty) |
87-
| `:q` | Graceful exit |
78+
| Key | Action |
79+
| ------------- | ---------------------------------------------------------------------------------------------------------- |
80+
| `Enter` | Submit message |
81+
| `Shift+Enter` | Insert newline |
82+
| `Escape` | Dismiss the overlay without changing the draft; otherwise interrupt the running turn; otherwise do nothing |
83+
| `Tab` | Autocomplete a path, or open the command picker when the draft starts with `/` |
84+
| `Ctrl+R` | Search global raw input history |
85+
| `Ctrl+C` | Graceful exit |
86+
| `Ctrl+D` | Graceful exit when the input is empty |
87+
| `:q` | Graceful exit |
88+
| `Ctrl+Z` | Suspend the process |
89+
| Mouse wheel | Scroll conversation history |
8890

8991
## Headless one-shot mode
9092

@@ -95,10 +97,12 @@ $ mc -p "summarize this repo"
9597
$ printf '%s\n' 'fix the failing tests' | mc
9698
```
9799

98-
- Enabled when `-p/--prompt` is provided or when stdin/stdout is not a TTY.
99-
- Reuses the same input parsing rules as the interactive UI for plain text, `/skill:name`, and standalone image paths.
100-
- Streams newline-delimited JSON events to stdout.
101-
- Interactive slash commands such as `/model` and `/help` are not available in headless mode.
100+
- Starts when `-p/--prompt` is provided or when stdin or stdout is not a TTY.
101+
- If stdout is redirected but stdin is still interactive, pass `-p`; headless mode will not fall back to an interactive prompt.
102+
- Uses the same parser as the TUI for plain text, `/skill:name`, and standalone image paths.
103+
- Writes raw NDJSON events to stdout for text deltas, tool activity, final messages, and `done` / `error` / `aborted` outcomes.
104+
- Headless runs still persist like normal sessions and show up in `/session` history for that working directory.
105+
- Interactive slash commands such as `/model`, `/session`, and `/help` are not available in headless mode.
102106

103107
## Docs
104108

‎index.html‎

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -372,8 +372,8 @@ <h3 class="mt-0 mb-2 font-semibold text-term-bright">edit</h3>
372372
>
373373
<h3 class="mt-0 mb-2 font-semibold text-term-bright">readImage</h3>
374374
<p class="mb-0 text-sm leading-relaxed text-term-fg">
375-
Reads PNG, JPEG, GIF, and WebP files so vision-capable models can
376-
inspect screenshots and other repo images.
375+
Reads PNG, JPEG, GIF, and WebP files as model input. Only
376+
registered when the active model supports images.
377377
</p>
378378
</article>
379379
</div>
@@ -396,22 +396,24 @@ <h3 class="mt-0 mb-2 font-semibold text-term-bright">
396396
<ul class="mb-0 text-sm">
397397
<li>
398398
<strong>Multi-provider model support</strong> — Anthropic,
399-
OpenAI, Google, Bedrock, Mistral, Groq, xAI, OpenRouter,
400-
Ollama, Copilot, and more via pi-ai.
399+
OpenAI, Google, Bedrock, Mistral, Groq, xAI, OpenRouter, Ollama,
400+
Copilot, and more via pi-ai.
401401
</li>
402402
<li>
403-
<strong>Streaming TUI</strong> — a scrolling markdown log,
404-
compact tool blocks, an animated divider, multi-line input, and
405-
a one-line pill status bar for model, cwd, git state, and
406-
session usage.
403+
<strong>Streaming TUI</strong> — markdown conversation log, tool
404+
blocks with diffs, animated divider, multi-line input, and a
405+
one-line pill status bar with independent ANSI16 effort/context
406+
tones.
407407
</li>
408408
<li>
409409
<strong>Session persistence</strong> — SQLite-backed sessions
410-
with undo, fork, resume, and cumulative usage stats.
410+
with undo, fork, resume, and cumulative usage stats. Sessions
411+
are scoped to the working directory.
411412
</li>
412413
<li>
413414
<strong>Reasoning and verbosity controls</strong> — toggle
414415
thinking visibility and verbose tool rendering on demand.
416+
Preferences persist across launches.
415417
</li>
416418
</ul>
417419
</article>
@@ -509,17 +511,17 @@ <h2>Commands</h2>
509511
<dl class="grid gap-x-4 gap-y-3 text-sm md:grid-cols-[auto_1fr]">
510512
<dt class="font-semibold text-term-bright">/model</dt>
511513
<dd class="text-term-fg">
512-
Switch models. Persists as the global default.
514+
Switch models and save the choice as the global default.
513515
</dd>
514516

515517
<dt class="font-semibold text-term-bright">/session</dt>
516518
<dd class="text-term-fg">
517-
List and resume sessions scoped to the current working directory.
519+
Open the session picker for the current working directory.
518520
</dd>
519521

520522
<dt class="font-semibold text-term-bright">/new</dt>
521523
<dd class="text-term-fg">
522-
Start a fresh session and reset cumulative usage counters.
524+
Start a fresh session and reset the running token and cost totals.
523525
</dd>
524526

525527
<dt class="font-semibold text-term-bright">/fork</dt>
@@ -530,13 +532,14 @@ <h2>Commands</h2>
530532

531533
<dt class="font-semibold text-term-bright">/undo</dt>
532534
<dd class="text-term-fg">
533-
Remove the last conversational turn (does not revert file
534-
changes).
535+
Remove the last conversational turn without touching filesystem
536+
changes.
535537
</dd>
536538

537539
<dt class="font-semibold text-term-bright">/reasoning</dt>
538540
<dd class="text-term-fg">
539-
Toggle thinking visibility. Persisted and restored on launch.
541+
Show or hide model thinking. The setting is saved and restored on
542+
launch.
540543
</dd>
541544

542545
<dt class="font-semibold text-term-bright">/verbose</dt>
@@ -547,17 +550,17 @@ <h2>Commands</h2>
547550

548551
<dt class="font-semibold text-term-bright">/login</dt>
549552
<dd class="text-term-fg">
550-
Interactive OAuth login for supported providers.
553+
Sign in with a supported OAuth provider.
551554
</dd>
552555

553556
<dt class="font-semibold text-term-bright">/logout</dt>
554557
<dd class="text-term-fg">
555-
Clear saved OAuth credentials for a logged-in provider.
558+
Remove saved OAuth credentials for a logged-in provider.
556559
</dd>
557560

558561
<dt class="font-semibold text-term-bright">/effort</dt>
559562
<dd class="text-term-fg">
560-
Set reasoning effort: low, medium, high, or xhigh.
563+
Choose low, medium, high, or xhigh reasoning effort.
561564
</dd>
562565

563566
<dt class="font-semibold text-term-bright">/help</dt>
@@ -589,7 +592,8 @@ <h2>Headless one-shot mode</h2>
589592
</li>
590593
<li>
591594
<strong>No interactive fallback.</strong> If stdout is redirected
592-
but stdin is still interactive, pass <code>-p</code> explicitly.
595+
but stdin is still interactive, pass <code>-p</code>; headless mode
596+
will not fall back to an interactive prompt.
593597
</li>
594598
<li>
595599
<strong>Shared input parsing.</strong> Plain text,
@@ -599,16 +603,17 @@ <h2>Headless one-shot mode</h2>
599603
<li>
600604
<strong>Raw NDJSON output.</strong> Stdout carries text deltas, tool
601605
activity, final messages, and <code>done</code>, <code>error</code>,
602-
or <code>aborted</code> outcomes instead of terminal rendering.
606+
or <code>aborted</code> outcomes.
603607
</li>
604608
<li>
605-
<strong>Normal session persistence.</strong> Headless runs still show
606-
up in <code>/session</code> history for that working directory.
609+
<strong>Normal session persistence.</strong> Headless runs still
610+
persist like normal sessions and show up in <code>/session</code>
611+
history for that working directory.
607612
</li>
608613
<li>
609614
<strong>No interactive slash commands.</strong> Commands such as
610615
<code>/model</code>, <code>/session</code>, and <code>/help</code>
611-
are rejected in headless mode.
616+
are not available in headless mode.
612617
</li>
613618
</ul>
614619
</section>

0 commit comments

Comments
 (0)