@open-tomato/rafa 0.12.0 → 0.15.0

package/README.md

@@ -108,6 +108,7 @@ the next one, so you rarely have to remember it.
    ```bash
    rafa init
    rafa doctor
+   rafa doctor --deep
    ```
 
    `init` writes `.rafa/config.yaml`, keeps `.rafa/` out of git, and on a
@@ -131,6 +132,7 @@ the next one, so you rarely have to remember it.
    rafa plan create --spec=.rafa/specs/my-feature.md   # 🪙
    rafa plan create --issue=42        # 🪙 the spec is issue #42's body
    rafa plan create --next            # 🪙 the first undone line of the Roadmap issue
+   rafa roadmap                        # see the roadmap as a table
    rafa plan show my-feature          # read it before you run it
    ```
 
@@ -200,6 +202,33 @@ Every command has help at three levels (`rafa --help`,
 `rafa loop --help`, `rafa loop start --help`), and
 `rafa describe --output=json` is the same roster for a tool or an agent.
 
+## Configuration
+
+Settings live in `.rafa/config.yaml` in the project, and in
+`~/.rafa/config.yaml` for every project on the machine; a setting in the
+project's file outranks the same one in yours. `rafa init` writes both
+with every setting commented out at its default, so uncomment a line,
+with its section line, to change it.
+
+### `cleanup`
+
+Three settings shape what `rafa cleanup` lists.
+
+| Key | Default | What it sets |
+|---|---|---|
+| `cleanup.staleDays` | `30` | the age in days past which a branch is listed as Stale |
+| `cleanup.worktreeIdleDays` | `7` | the idle days past which a worktree is listed |
+| `cleanup.keep` | `[]` | glob patterns naming branches that are never listed |
+
+Both day counts take a whole number above zero.
+
+```yaml
+cleanup:
+  staleDays: 30
+  worktreeIdleDays: 7
+  keep: ["release/*"]
+```
+
 ## Specs, issues and the roadmap
 
 You can plan from a local file and never touch a board. When you want
@@ -342,11 +371,11 @@ and a line here is ticked by the change that finishes the feature.
 - ✅ Before a run, see what it can do on this machine and under your accounts
 - ✅ See every skill and agent a run would use, browse them, and ask
   about them in plain language
-- ⬜ The roadmap in one table: what is ready, what blocks it, and what
+- ✅ The roadmap in one table: what is ready, what blocks it, and what
   already has a plan, a branch or a pull request
-- ⬜ `rafa doctor --deep`: what a loop session and its subagents can
+- ✅ `rafa doctor --deep`: what a loop session and its subagents can
   actually reach — settings, `PATH`, providers and the tools its stack needs
-- ⬜ Clean up merged, stale and unpushed branches and idle worktrees
+- ✅ Clean up merged, stale and unpushed branches and idle worktrees
 - ⬜ `rafa status`: everything in one snapshot, and one line about what
   changed since you last looked
 - ⬜ The right skills reach the right task, chosen when the plan is