mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-11-17 04:45:33 -08:00
Refresh agent docs, README and quick reference for v2.4.x: document plan2code-bot, launcher model menu, test/dev env vars, full npm test pipeline, GitHub-issues pathfinder backend, and dedupe command lists in favor of the README
AI Assisted
This commit is contained in:
1 parent
cb86034de9
commit
bfb47f3a8e
9 files changed
+144
-159
No files matched your search
@@ -34,13 +34,13 @@ Details: [Plan2Code Metrics](./.agents-docs/AGENTS-plan2code-metrics.md)
|
||||
|
||||
## Plan2Code Status Line (Claude CLI)
|
||||
|
||||
Optional CLI status bar (`src/statusline-claude/`) for Claude Code. Displays model, project, branch, context usage, usage stats (rate limits or token counts), git diff stats, and duration. Reads data directly from Claude Code's stdin JSON — no API calls, no auth, no background processes. Included in `Install All + dev tools` (`A`); also available via `install.js` Custom → S (opt-in).
|
||||
Optional CLI status bar (`src/statusline-claude/`) for Claude Code. Displays model (+ effort), project/worktree, branch, git diff stats, duration + session cost, context usage, and usage stats (rate limits or token counts). Reads data directly from Claude Code's stdin JSON (plus timeout-bounded git calls): no API calls, no auth, no background processes.
|
||||
|
||||
Details: [Architecture](./.agents-docs/AGENTS-architecture.md) (see Status Line section)
|
||||
|
||||
## Web Console
|
||||
|
||||
Optional local browser UI (`src/web-console/`) that every skill offers at the start of a session, so questions, sign-off gates, build progress and the document taking shape can be worked through in a page instead of the terminal. The bare `plan2code` skill is the front door: it opens the console's dashboard — a card menu of every skill — and a pick launches that skill on the same page by resuming the session under its workflow. A phase's sign-off card offers to run the code review first — before approval — and a finished quick task's hand-off offers a **Review it now** button; either runs `plan2code-review` on the page in the same session. Finished (not paused) screens offer **Back to the dashboard**, and notes and quick questions can carry image and document (text, code, PDF) attachments (stored in the session dir, never the project). An **Ask** tab, always last, opens a Quick question chat the running agent answers at its next check-in, on its own channel beside the cards (edits only after the person approves them); context is attached only on purpose, through **+ Add context**, and an empty conversation offers starter questions. A Role in User Preferences (asked for by a dashboard banner until set) orders the starter templates on Pathfinder, Plan and Quick Task's fresh-idea card (`"templates": "idea"`, wording in `public/starters.js`) and the Ask starters; it never changes what a skill asks. Note attachments a spec file cites are copied into `specs/<idea>/attachments/` by the agent with `console.mjs keep`; the server itself never writes into a project. The footer's folder label opens a **Workspace** dialog where the person adds more folders as read-only context for the whole console session, each addressed as `@name` in answers, notes and Ask (contract in `console.md` → Workspace). A green / yellow / red **session meter** in the top bar counts weighted points as one console session chains skill runs (`public/meter.js`; agents report per-unit work with `run` in a post) and suggests a fresh console session at red. The **?** at the top right opens a 16-topic Help dialog built into the page, so it reads even with the server gone. Zero dependencies, detached `node` server on `127.0.0.1`, bundled into each skill via `additionalReferences`.
|
||||
Optional local browser UI (`src/web-console/`, zero dependencies, detached `node` server on `127.0.0.1`) bundled into every skill via `additionalReferences`. The bare `plan2code` skill opens its dashboard, a card menu that launches any skill in the same session. Pages cover questions, sign-off gates (with an in-page code review), build progress, the living document, an **Ask** chat, a read-only **Workspace** of extra folders, a session meter, a built-in 16-topic Help, a first-run Welcome, User Preferences (gear) and a bug/idea link to GitHub issues. The agent-facing contract is `console.md` / `building.md`; the server never writes into a project.
|
||||
|
||||
Details: [Architecture](./.agents-docs/AGENTS-architecture.md) (see Web Console section) and [.readme/web-console.md](./.readme/web-console.md)
|
||||
|
||||
|
||||
Reference in new issue
Block a user