@naxodev/apnea 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -20,8 +20,7 @@ only rebinds roles to profile names that already exist.
20
20
  `dist/cli.js` with a `#!/usr/bin/env bun` shebang, and npm does not enforce the `engines.bun`
21
21
  key. If you install `@naxodev/apnea` globally with only `node` on `PATH`, the `apnea` command
22
22
  will fail on first invocation — this is the most likely first-run failure for a new user.
23
- - **herdr**, for pane-based dispatch. The optional `floating` pane style additionally needs
24
- **herdr ≥ 0.7.4** plus the linked plugin (see [`docs/protocol/config.md`](docs/protocol/config.md)).
23
+ - **herdr**, for reusable interactive pane dispatch.
25
24
  - **jj or git.** Per [ADR 0007](docs/adr/0007-jj-first-commits.md), if neither is present
26
25
  auto-commit is refused.
27
26
  - **At least one agent CLI** — `pi`, `claude`, or `codex`.
@@ -53,8 +52,7 @@ Optionally put it on `PATH`, e.g. `ln -s "$(pwd)/dist/cli.js" ~/.local/bin/apnea
53
52
 
54
53
  ## Sixty-second quickstart
55
54
 
56
- 1. `apnea setup` — writes global profiles to `~/.config/apnea/config.json` (and the herdr
57
- `apnea` plugin, if herdr is present).
55
+ 1. `apnea setup` — writes global profiles to `~/.config/apnea/config.json`.
58
56
  2. `apnea start "<goal>"` — starts a run against your working copy.
59
57
  3. `apnea status` — a read-only snapshot of where the run stands and what to call next.
60
58
 
@@ -109,14 +107,14 @@ See [`docs/protocol/config.md`](docs/protocol/config.md) for the budget-floor ar
109
107
  ### Setup flags
110
108
 
111
109
  ```text
112
- /apnea setup # ~/.config/apnea/config.json from PATH (+ herdr apnea plugin when herdr is present)
110
+ /apnea setup # ~/.config/apnea/config.json from PATH
113
111
  /apnea setup --project # also .apnea/config.json role→profile only
114
112
  /apnea setup --agents-md # also write/refresh an AGENTS.md loop primer at the repo root
115
113
  ```
116
114
 
117
- `pane_style` (`regular` default, `floating` opt-in) lives in config; floating needs herdr ≥ 0.7.4
118
-
119
- - the linked plugin see [`docs/protocol/config.md`](docs/protocol/config.md).
115
+ After upgrading from a version with floating panes, old copied
116
+ `~/.config/apnea/herdr-plugin` files are inert. Apnea does not unlink or delete them; remove that
117
+ directory manually if you no longer need it.
120
118
 
121
119
  The `@naxodev/pi-apnea` adapter applies Pi-specific role launch behavior. The core package remains
122
120
  host-neutral.
@@ -129,8 +127,8 @@ UI in v1.**
129
127
  **What you can rely on:** the loop, the artifact contract, and the CLI are implemented, and the
130
128
  extension suite is green — CI runs it on every pull request.
131
129
 
132
- **What may still change:** the command surface and config shape may move before `1.0`. This is
133
- `0.1.0` — breaking changes will land in minor bumps, not patches.
130
+ **What may still change:** the command surface and config shape may move before `1.0`. Breaking
131
+ changes will land in minor bumps, not patches.
134
132
 
135
133
  **Non-goals for v1:** worktrees, parallel coders, push/PR automation, memory store, native
136
134
  CLAUDE.md injection, force-approve, config UI.