Skip to content

Commit c1368c9

Browse files
BunsDevclaude
andcommitted
docs: document the welcome screen in the home page
Describes the rounded status panel users see on launch — familiar art, status block (Model/Provider/Daemon/Familiar/Goal), F2 switcher hint, and small-terminal collapse — with deep links to the subsystem docs that own each value, so this section doesn't drift as those evolve. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 19c27c9 commit c1368c9

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

docs/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,28 @@ See [Providers](providers) for setup instructions for every supported provider.
150150

151151
---
152152

153+
## The welcome screen
154+
155+
When you launch `coven-code` interactively, the home screen opens with a single rounded panel titled `Coven Code v<version>`. It's the at-a-glance status surface — every value comes from another subsystem, so use it as a jumping-off point rather than a source of truth.
156+
157+
**Left column** — your familiar's portrait (animated glyph for built-ins, static card for daemon-registered familiars) under a `Welcome back <user>!` greeting. The art is driven by the `"familiar"` field in your settings; see [Coven Familiars](familiars).
158+
159+
**Right column** — a rotating getting-started tip, then a **Status** block:
160+
161+
| Field | What it shows | Configured in |
162+
|-------|---------------|---------------|
163+
| `Model` | Active model id, or the effective default if unset | `model` in [settings.json](configuration), `/model` |
164+
| `Provider` | Active provider id (`anthropic` when unset) | `provider` in [settings.json](configuration), see [Providers](providers) |
165+
| `Daemon` | `online` / `offline` from a cheap socket check — no RPC | Install `@opencoven/coven` to bring it online |
166+
| `Familiar` | Current familiar id, with an `(F2 to switch)` hint | `familiar` in settings, `/familiar`, or **F2** |
167+
| `Goal` | Active autonomous goal (only shown when one is set) | `/goal <objective>` |
168+
169+
Press **F2** at any time to open the familiar switcher popup.
170+
171+
On terminals narrower than ~30 columns or shorter than 11 rows, the panel collapses to a single line — `Coven Code v… · <model> · <daemon> · <familiar>` — so the essentials stay visible even in a tiny pane.
172+
173+
---
174+
153175
## Slash commands
154176

155177
Inside the interactive TUI, type `/` to see all available commands. Common ones:

0 commit comments

Comments
 (0)