kaizen-agent 1.3.10 → 1.5.0

package/README.md

@@ -14,15 +14,20 @@
 
 ---
 
+macOS, Linux, WSL — one paste:
+
 ```bash
-# 1. Install Bun (prerequisite) — macOS, Linux, WSL
-curl -fsSL https://bun.sh/install | bash
-#    Windows PowerShell: powershell -c "irm bun.sh/install.ps1 | iex"
+curl -fsSL https://bun.sh/install | bash && ~/.bun/bin/bunx kaizen-agent
+```
+
+Windows PowerShell — one paste:
 
-# 2. Install Kaizen
-bunx kaizen-agent
+```powershell
+irm bun.sh/install.ps1 | iex; & "$env:USERPROFILE\.bun\bin\bunx.exe" kaizen-agent
 ```
 
+Already have Bun? `bunx kaizen-agent`.
+
 ---
 
 ## The problem
@@ -273,6 +278,25 @@ recorded in the run's approval file.
 `a` switches between this project and every project kaizen knows about. Below a hundred
 columns the board stacks into a list rather than squeezing five columns into sixty.
 
+### In a browser
+
+```bash
+kaizen web
+```
+
+serves the same board on `http://127.0.0.1:7420/` — loopback only, no account — and
+opens it in a Chromium-family browser as an app window when one is installed, otherwise
+in a tab.
+
+<img src="https://raw.githubusercontent.com/hfadhlullah/kaizen/main/assets/web-board.png" alt="kaizen web board" width="760">
+
+Same columns, same files: an idea added here lands in `inbox.md`, a run
+started here opens your agent in a new terminal exactly as `r` does, and the board
+redraws as your agents write to disk. Mouse first; the TUI's keys still work. Click a card for its plan, review and
+backlog; `⋯` on a card runs, edits, rejects or abandons. Theme lives in its settings;
+everything else is still `kaizen settings`. `--port N` picks a port, `--no-open` just
+serves, `?all=1` in the URL opens on every project.
+
 ### Mouse
 
 Off by default. Turn it on in `kaizen settings` under `ui.mouse`, and clicking a row or
@@ -294,13 +318,12 @@ the only prerequisite. Pick your platform:
 In PowerShell:
 
 ```powershell
-# 1. Install Bun
-powershell -c "irm bun.sh/install.ps1 | iex"
-
-# 2. Reopen PowerShell so bun is on your PATH, then:
-bunx kaizen-agent
+irm bun.sh/install.ps1 | iex; & "$env:USERPROFILE\.bun\bin\bunx.exe" kaizen-agent
 ```
 
+One line, because the shell that just installed Bun does not have it on `PATH` yet;
+the full path sidesteps that. Next time, plain `bunx kaizen-agent`.
+
 Git is not required. Where it is missing, kaizen copies itself into `%USERPROFILE%\kaizen`
 instead of cloning, and `bunx kaizen-agent` is also how you update. Links are made as
 directory junctions and file copies, so no administrator rights or Developer Mode are
@@ -312,28 +335,23 @@ needed. WSL users can follow the Linux instructions instead.
 <summary><b>macOS</b></summary>
 
 ```bash
-# 1. Install Bun
-curl -fsSL https://bun.sh/install | bash
-# or: brew install oven-sh/bun/bun
-
-# 2. Install Kaizen
-bunx kaizen-agent
+curl -fsSL https://bun.sh/install | bash && ~/.bun/bin/bunx kaizen-agent
 ```
 
+Or `brew install oven-sh/bun/bun`, then `bunx kaizen-agent`.
+
 </details>
 
 <details>
 <summary><b>Linux</b></summary>
 
 ```bash
-# 1. Install Bun
-curl -fsSL https://bun.sh/install | bash
-# or: npm install -g bun
-
-# 2. Install Kaizen
-bunx kaizen-agent
+curl -fsSL https://bun.sh/install | bash && ~/.bun/bin/bunx kaizen-agent
 ```
 
+The full path is there because the shell that just installed Bun does not have it on
+`PATH` until you open a new one. Next time, plain `bunx kaizen-agent`.
+
 </details>
 
 The installer walks you through where to install, prompts for your workflow preset (`medium`, `low`, or `ultra`), then tells you what to type next. Restart your editor afterwards.
@@ -574,11 +592,20 @@ with a comment on each key, if you would rather edit the file.
 | `--yes` | Take every default, ask nothing |
 | `--verbose` | List every link instead of a one-line summary |
 | `upgrade` | Pull, relink, and clear the installer cache. No prompts. |
+| `uninstall` | Remove the links, the clone, and the launcher. Asks whether to keep your runs and settings. |
+| `uninstall --purge` | The same, and delete `~/.kaizen` and this project's `.kaizen/` too. |
 | `settings` | Open the settings browser for the nearest `.kaizen/`. Also `config`. |
 
-A global install also writes `~/.local/bin/kaizen`, a two-line launcher pointing at
+Uninstalling works the same on Linux, macOS and Windows — `kaizen uninstall`, or
+`bunx kaizen-agent uninstall` when the command itself is already gone. It offers three
+answers — keep your runs and settings, remove everything, or cancel — and takes the
+first without asking when the output is not a terminal. It lists what it removed; the `## Kaizen workflow` line in each project's `CLAUDE.md` is left for
+you to delete, since you may have edited around it.
+
+A global install also writes `~/.local/bin/kaizen` (`kaizen.cmd` in bun's bin
+directory on Windows), a two-line launcher pointing at
 the clone, so `kaizen upgrade` works from anywhere. It tells you if that directory is
-not on your PATH. Delete the file to remove it; `--project` installs skip it.
+not on your PATH. `uninstall` removes it; `--project` installs skip it.
 
 Re-running is safe: correct links are left alone.