prloom 0.1.6 → 0.2.0

package/README.md

@@ -9,10 +9,12 @@ You write a plan (a Markdown checklist), `prloom` turns it into a dedicated git
 ## How It Works
 
 - Plans start locally in `prloom/.local/inbox/` (gitignored; clean `git status`).
-- The dispatcher ingests a plan into a new branch/worktree at `prloom/plans/<id>.md` and opens a draft PR.
-- The worker agent executes exactly one TODO per iteration and updates the plan in-branch.
+- The dispatcher ingests a plan into a new branch/worktree and opens a draft PR.
+- The plan file stays in `prloom/.local/plan.md` (never committed) — the PR description contains the Objective, Context, and Progress Log.
+- The worker agent executes exactly one TODO per iteration and updates the local plan file.
 - PR comments/reviews trigger a triage agent which updates the plan with new TODOs and posts a reply.
 - When all TODOs are complete, the PR is marked ready; you merge when satisfied.
+- On squash merge, the plan content is preserved in the commit message.
 
 ## Requirements
 
@@ -62,19 +64,19 @@ bun run build
 ### Commands
 
 - `prloom init`
-  - Initializes `.prloom/`, ensures `.prloom/` is gitignored, and writes `prloom.config.json`.
+  - Initializes `prloom/`, ensures `prloom/.local/` is gitignored, and writes `prloom/config.json`.
 - `prloom new [plan-id] [--agent <codex|opencode|claude>]`
-  - Creates `.prloom/inbox/<id>.md` and launches an interactive designer session.
+  - Creates `prloom/.local/inbox/<id>.md` and launches an interactive designer session.
 - `prloom start`
   - Starts the dispatcher loop (ingests inbox plans, runs TODOs, polls PR feedback).
 - `prloom status`
-  - Shows inbox plans and active plans tracked in `.prloom/state.json`.
+  - Shows inbox plans and active plans tracked in `prloom/.local/state.json`.
 - `prloom edit <plan-id> [--agent <...>]`
-  - Edits a plan either in inbox (pre-dispatch) or in the plan’s worktree (post-dispatch).
+  - Edits a plan either in inbox (pre-dispatch) or in the plan's worktree (post-dispatch).
 - `prloom stop <plan-id>` / `prloom unpause <plan-id>`
   - Pauses/resumes automation for an active plan.
 - `prloom open <plan-id>`
-  - Opens the configured agent’s interactive TUI in the plan worktree (requires paused).
+  - Opens the configured agent's interactive TUI in the plan worktree (requires paused).
 - `prloom poll [plan-id]`
   - Forces an immediate PR-feedback poll.
   - With `<plan-id>`: poll once for that plan without shifting its schedule.
@@ -100,14 +102,39 @@ Create `prloom/config.json`:
 {
   "agents": {
     "default": "opencode",
-    "designer": "codex"
+    "opencode": {
+      "default": "gpt-4",
+      "designer": "claude-sonnet-4-20250514",
+      "worker": "gpt-4-turbo"
+    },
+    "claude": {
+      "default": "sonnet",
+      "designer": "opus"
+    }
   },
   "worktrees_dir": "prloom/.local/worktrees",
-  "poll_interval_ms": 60000,
+  "github_poll_interval_ms": 60000,
   "base_branch": "main"
 }
 ```
 
+### Agent Configuration
+
+The `agents` config allows you to:
+- Set a default agent app (e.g., `opencode`, `claude`, `codex`, `gemini`)
+- Configure model preferences per agent, with stage-specific overrides
+
+**Structure:**
+- `agents.default`: Which agent app to use (e.g., `"opencode"`)
+- `agents.<agent>`: Model configuration for that agent
+  - `default`: Default model for all stages
+  - `designer`: Model override for the designer stage
+  - `worker`: Model override for the worker stage
+  - `reviewer`: Model override for the reviewer stage
+  - `triage`: Model override for the triage stage
+
+This design keeps model identifiers scoped to their agent (since each agent uses different model names), while making it easy to switch between agents.
+
 ## Repository Context
 
 You can provide repository-specific context to agents by creating markdown files in the `prloom/` directory:
@@ -116,10 +143,12 @@ You can provide repository-specific context to agents by creating markdown files
 repo/
 ├── prloom/
 │   ├── config.json   # Configuration
-│   ├── plans/        # Committed plans (on PR branches)
 │   ├── planner.md    # Appended to designer prompts
 │   ├── worker.md     # Appended to worker prompts
 │   └── .local/       # Gitignored (runtime state)
+│       ├── inbox/    # Plans awaiting dispatch
+│       ├── plan.md   # Active plan (per worktree)
+│       └── worktrees/
 ```
 
 - **`prloom/planner.md`**: Architecture info, coding conventions, design patterns
@@ -130,4 +159,4 @@ These files are appended to the respective agent prompts automatically.
 ## Notes
 
 - Runtime state is stored under `prloom/.local/` (gitignored).
-- The plan file is committed on the PR branch at `prloom/plans/<id>.md` and lands on the configured `base_branch` when you merge the PR.
+- Plan files are never committed to the repository — the PR description and squash commit message serve as the permanent record.