@eddie-doc/cli 1.4.4 → 1.4.6

package/README.md

@@ -36,6 +36,8 @@ Open (24)
 - [Concepts](#concepts)
 - [Choosing a document, mapping and annotation](#choosing-a-document-mapping-and-annotation)
 - [Command reference](#command-reference)
+- [Interactive mode: `eddie tui`](#interactive-mode-eddie-tui)
+- [Skills for AI coding agents: `eddie skills`](#skills-for-ai-coding-agents-eddie-skills)
 - [Configuration](#configuration)
 - [Scripting: JSON output and exit codes](#scripting-json-output-and-exit-codes)
 - [Recipes](#recipes)
@@ -279,11 +281,13 @@ skips the question. *VS Code: Merge Mappings into This One.*
 #### `rounds` (alias `mappings`) — list rounds and mappings
 
 ```text
-eddie rounds <source.adoc> [--json]
+eddie rounds [source.adoc] [--json]
 ```
 
-Each round with its mappings, the counts per bucket, and each sidecar path. *VS
-Code: Switch Round / Mapping.*
+Each round with its mappings, the counts per bucket, and each sidecar path.
+Without a source, every mapping in the workspace, grouped by document. To browse
+them interactively, use [`eddie tui`](#interactive-mode-eddie-tui). *VS Code:
+Switch Round / Mapping.*
 
 #### `describe` (alias `edit-round`) — label a mapping and its round
 
@@ -530,6 +534,8 @@ is accepted as a short form.
 
 | Command | Does |
 | --- | --- |
+| `eddie tui [source.adoc]` (aliases `browse`, `ui`) | Full-screen browser; see [Interactive mode](#interactive-mode-eddie-tui). |
+| `eddie skills [install, list, remove, show]` | Install the agent skills for Claude Code, Codex, Cursor, Gemini CLI, Copilot; see [Skills](#skills-for-ai-coding-agents-eddie-skills). |
 | `eddie status` (alias `reviews`) | Every reviewed document in the workspace, with open counts, rounds and the newest mapping. *VS Code: Switch Review.* |
 | `eddie folder [source.adoc] [--open]` | The review folder, or one document's folder in it. *VS Code: Open Review Folder.* |
 | `eddie migrate [--dry-run] [--yes]` | Moves old-layout sidecars (beside each `.adoc`) into the review folder, rewriting their relative paths. *VS Code: Move Reviews into Review Folder.* |
@@ -553,6 +559,132 @@ is accepted as a short form.
 | `-q, --quiet` | Fewer notices on stderr. |
 | `-h, --help` | Help. |
 
+## Interactive mode: `eddie tui`
+
+```bash
+eddie tui                 # every reviewed document in the workspace
+eddie tui src/ch04.adoc   # straight to one document
+```
+
+A full-screen browser for the terminal, the counterpart of the editor's
+sidebar. It goes **documents → mappings (rounds) → annotations**. A level with
+only one choice is skipped. The annotation list is grouped Open / Needs review /
+Unmatched / Done. Below it, the selected remark is shown with the editor's
+comment, the marked words, the source lines it points at, and the reply thread.
+
+```text
+ eddie · book/chapter-01.adoc › Revision 1 · Acme
+  #3 A    OPEN      Comment   L22    Add a small diagram illustrating this edge.
+  #4 A    OPEN      Highlight L30    Reword: 'trust or lineage'.
+› #1 A    DONE      Highlight L7     Strong framing — keep this.  ↳1
+  #2 A    DONE      Delete    L12    Delete: too advanced for an intro.
+──────────────────────────────────────────────────────────────────────────────
+#1 A  Highlight  Resolved  page 2 · line 7, marker 1.00
+Editor: Strong framing — keep this.
+marked: relationships at the center of the model
+▌    7 │ A knowledge graph is a structured representation of information where…
+▌    8 │ are connected by well-defined relationships. Unlike a relational data…
+  ↳ VP · 2026-10-13
+    Fixed in the next draft
+ r resolve  c confirm  a reply  l link  t triage  f fix  o pdf  b group  / search
+```
+
+| Key | Where | Does |
+| --- | --- | --- |
+| `↑` `↓` / `j` `k`, `PgUp` `PgDn`, `g` `G` | everywhere | Move. |
+| `Enter` / `→` | everywhere | Open. On an annotation: its replies, or triage if it is unmatched. |
+| `Esc` / `←` / `Backspace` | everywhere | Back. |
+| `q`, `Ctrl-C` | everywhere | Quit. |
+| `?` | everywhere | All keys. |
+| `S` | everywhere | Install agent skills: tick the AI tools you use, then project or user. |
+| `R` | mappings | Re-map every round of the document. |
+| `p` | mappings | Export the mapping's report. |
+| `r` | annotations | Resolve / reopen. |
+| `c` | annotations | Confirm the match. |
+| `a` | annotations | Add a reply (typed in the footer; `Esc` cancels). |
+| `e` | annotations | Edit or delete a reply. |
+| `l` | annotations | Link to a line number. |
+| `t` | annotations | Ranked candidate lines; pick one to link. |
+| `m` | annotations | Re-match automatically. |
+| `f` | annotations | The mark's quick fixes; shows the diff and asks before writing. |
+| `A` | annotations | Apply every confident edit, after showing the plan. |
+| `o` | annotations | Open the PDF. |
+| `b` / `/` / `h` | annotations | Filter by group (cycles) / search text / hide resolved. |
+
+Every action saves immediately, to the same files the other commands use, so an
+open VS Code window updates. Set `NO_COLOR=1` for monochrome. `tui` needs an
+interactive terminal; in scripts use `list`, `show` and `rounds`.
+
+## Skills for AI coding agents: `eddie skills`
+
+Eddie ships three [Agent Skills](https://agentskills.io) that teach an AI coding
+tool to use it properly:
+
+| Skill | Teaches |
+| --- | --- |
+| `eddie-review` | Working through an editor's remarks: list, read in context, edit, reply, resolve, apply, triage. Includes a command reference. |
+| `eddie-anchors` | Keeping `// eddie:` anchor lines intact while rewriting `.adoc` files, so marks stay on the right paragraphs. |
+| `eddie-pipeline` | Mapping a newly returned PDF, rounds, reports, stamping, and CI automation. |
+
+```console
+$ eddie skills
+Which AI coding tools do you use? Eddie's skills will be installed where each one looks.
+  1) Claude Code   (found here)
+  2) OpenAI Codex
+  3) Cursor
+  4) Gemini CLI
+  5) GitHub Copilot
+  6) Other (any tool that reads .agents/skills: OpenCode, Amp, Kiro…)
+Numbers separated by commas, or "a" for all [1]: 1,3
+Install for:
+  p) this project — /work/book   (commit them so collaborators get them)
+  u) your user account — /Users/me   (every project on this machine)
+p or u [p]: p
+.claude/skills
+  installed eddie-review
+  installed eddie-anchors
+  installed eddie-pipeline
+```
+
+Tools already in use are found from their files (`CLAUDE.md`, `.cursor/`,
+`.gemini/`, …) and offered as the default. Each tool reads skills from its own
+folders, and Eddie writes the fewest copies that reach all the tools you picked:
+
+| Tool | Project folder | User folder |
+| --- | --- | --- |
+| Claude Code | `.claude/skills` | `~/.claude/skills` |
+| OpenAI Codex | `.agents/skills` | `~/.agents/skills` |
+| Cursor | `.agents/skills` (also reads `.cursor/`, `.claude/`, `.codex/skills`) | same under `~` |
+| Gemini CLI | `.agents/skills` (or `.gemini/skills`) | same under `~` |
+| GitHub Copilot | `.agents/skills` (also `.github/`, `.claude/skills`) | `~/.agents/skills` (or `~/.copilot/skills`) |
+| Other tools | `.agents/skills` | `~/.agents/skills` |
+
+So Claude Code with Cursor is one copy in `.claude/skills`, while Claude Code with
+Codex needs `.claude/skills` and `.agents/skills`. A tool that reads both folders
+then sees each skill twice, which is harmless.
+
+```bash
+eddie skills install --tool claude,codex          # in a script: no questions
+eddie skills install --all --scope user           # every tool, for your account
+eddie skills list                                 # what is installed where, which version
+eddie skills install                              # again after upgrading eddie: updates them
+eddie skills remove --yes                         # take them out
+eddie skills show eddie-review                    # read one
+```
+
+Each installed `SKILL.md` records `generator: eddie-doc` and the version that
+wrote it. Eddie updates and removes only its own skills. A skill of the same name
+that you wrote is never replaced (unless `--force`) and never removed. Without
+`--tool` and without a terminal, Eddie installs for the tools it detects, and
+fails with a usage error if there are none.
+
+How Claude Code and other agents then use Eddie, with example prompts:
+<https://volland.github.io/eddie-doc/agents.html>.
+
+The same installer is in the editors: **Eddie Doc: Install Agent Skills for AI
+Tools…** in VS Code, **Install agent skills for AI tools…** in Obsidian (into the
+vault), and the `S` key in `eddie tui`.
+
 ## Configuration
 
 The CLI reads the same settings as the editors, with the same names and
@@ -716,7 +848,8 @@ asciidoctor-pdf -o build/ch04.pdf ch04.adoc && eddie stamp build/ch04.pdf ch04.a
 
 ### With an AI coding agent
 
-Every command can run without prompts (`--yes`) and produce JSON (`--json`), so
+Install the skills first (`eddie skills`); the agent then knows the workflow
+below, the anchor rules, and every command. Every command can run without prompts (`--yes`) and produce JSON (`--json`), so
 an agent can work through a review: list the open remarks, read each with
 `eddie show`, edit the prose, then `eddie reply` and `eddie resolve`. The
 remarks it handles show up as answered in VS Code and Obsidian, and in the