aiur-cli 0.0.3 → 0.0.5-nightly.24dcc4d

package/README.md

@@ -4,6 +4,10 @@
 
 Oversee a fleet of coding agents that **coordinate via events**.
 
+Aiur watches your issue tracker, dispatches one agent per ticket into its own
+workspace and checkout, and gives you four ways to supervise the fleet instead
+of babysitting individual coding sessions.
+
 > [!WARNING]
 > **Use at your own risk.** Aiur is an unstable, vibecoded engineering preview for trusted
 > environments only. It **bypasses all agent permission prompts** and has very few efficiency
@@ -12,72 +16,104 @@ Oversee a fleet of coding agents that **coordinate via events**.
 > Provided "as is", without warranty of any kind. You assume all risk for any cost, token
 > spend, data loss, or damage from running it.
 
-## Install
-
-```bash
-npm install -g aiur-cli
-```
-
-Requires [tmux](https://github.com/tmux/tmux) at runtime. Install
-[opencode](https://opencode.ai) too for in-pane agent chat.
-
-When a newer `aiur-cli` is published, a one-line update notice is printed to
-stderr (checked in the background at most once a day, never blocking your
-command). Set `AIUR_NO_UPDATE_NOTIFIER=1` to silence it; it is also skipped under
-CI (`CI=true`).
-
 ## Get started
 
 ```bash
+npm install -g aiur-cli   # Node.js 18+
+
 cd your-repo
-aiur init     # interactive setup wizard
-aiur          # start agents (foreground); use `aiur --bg` to detach
+aiur init                 # interactive setup wizard
+aiur                      # start the run
 ```
 
-`aiur init` scaffolds `.aiurconfig` and provisions the repo. It walks you through:
+`aiur init` scaffolds `.aiur/config` and provisions the repo: tracker and
+repository, agent backends and routing, concurrency and turn limits, the GitHub
+token, and the `agent:*` lifecycle labels. Re-running resumes from your saved
+answers.
+
+When setup finishes, label the issues you want worked `agent:todo` and run
+`aiur`.
+
+| Requirement | Why |
+| --- | --- |
+| [tmux](https://github.com/tmux/tmux) | Runtime for the TUI and agent panes |
+| [opencode](https://opencode.ai) | In-pane agent chat (provisioned on install) |
+| Claude Code or Codex | The agents themselves |
 
-1. **Where to store config** — repo-local `./.aiurconfig` or global `~/.aiurconfig`.
-2. **Tracker** — GitHub or Linear, plus the repo.
-3. **Agents & routing** — Claude and/or Codex, optional per-complexity model
-   routing, and the permission mode.
-4. **Limits** — max concurrent agents, turns, duration, pre-warmed sessions, and
-   polling interval.
-5. **GitHub token** — to create labels and act as the bot account.
-6. **Labels** — the lifecycle (`agent:*`), complexity, model, and remote-control
-   labels aiur routes on. Only missing labels are created; a group that already
-   exists is reported as created and skipped.
+## The four surfaces
 
-Re-running resumes from your saved answers. When setup finishes, add `agent:todo`
-to the issues you want worked and run `aiur`.
+| Surface | What it gives you | How to open it |
+| --- | --- | --- |
+| **CLI** | Scriptable control of a run from any shell | `aiur status`, `aiur pause 142` |
+| **TUI** | Live agent board plus chat panes, in your terminal | `aiur` (foreground) |
+| **Dashboard** | Browser view of the fleet, decisions, and analytics | `http://127.0.0.1:4000` |
+| **Stream Deck** | Physical keys and dictation for the fleet | Separate sidecar, see below |
 
-## Commands
+### CLI
 
 | Command | What it does |
-|---|---|
-| `aiur init` | Interactive setup wizard (scaffold `.aiurconfig`) |
-| `aiur` | Start the workflow in the foreground (local-only bind) |
-| `aiur --bg` | Start a headless BEAM in one detached tmux lifetime session |
-| `aiur status` | Show active agents and their state |
-| `aiur pause <id…>` / `resume <id…>` | Pause or resume agents by issue ID |
-| `aiur stop` | Stop the running session |
-
-## Features
-
-- **Issue Monitoring** — Dispatch agents automatically via GitHub or Linear tickets.
-- **Shared Bus** — Agents auto-pub/sub to dependency events, unblocking work early.
-- **Optimize Effort** — Story points guide model sizes and skills. Supports Claude and Codex.
-- **Take the Wheel** — Drive at any moment via pre-warmed [Opencode](https://opencode.ai) sessions in configurable tmux panes.
-- **Smart Alerts** — Customize notifications and sounds when agents finish, stall, or need a decision.
-- **Live Dashboard** — Shareable web view of every agent, event, and progress bar.
-
-Background mode is headless inside Aiur: it skips the interactive agent-list
-pane, chat/prewarm panes, and dashboard unless you explicitly opt into a
-dashboard port. The launcher still keeps one detached tmux session as the BEAM
-lifetime holder. Re-running `aiur --bg` against a live session exits with an
-already-running hint; stale tmux state is cleaned up before restart.
+| --- | --- |
+| `aiur init` | Interactive setup wizard |
+| `aiur` | Start the run in the foreground with the TUI |
+| `aiur --bg` | Start a detached headless run, dashboard still served |
+| `aiur status` | Daemon state, active agents, and the current concurrency cap |
+| `aiur alerts --needs-attention` | Unresolved items waiting on you |
+| `aiur pause <id…>` / `aiur resume <id…>` | Pause or resume agents by issue id |
+| `aiur message <id> "<text>"` | Send text into a live agent session |
+| `aiur set max-agents <n>` | Change the concurrency cap without restarting |
+| `aiur --todo <id…> [--only]` | Queue tickets; `--only` dequeues the rest |
+| `aiur stop` / `aiur restart` | Stop the session, or refresh the release and restart |
+
+Add `--no-dashboard` to either mode to skip the web listener.
+
+### TUI
+
+The foreground run opens a tmux board with one row per ticket, showing runtime,
+turn count, backend, pinned model, and a state glyph. Press `enter` on a row to
+open that agent's chat pane beside the board, `space` to pause or resume, `←`
+and `→` to change the concurrency cap, and `?` for the full keymap.
+
+### Dashboard
+
+Served on foreground and `--bg` runs at the host and port in your config,
+`http://127.0.0.1:4000` by default. The launch output prints the real URL.
+
+| Page | What it shows |
+| --- | --- |
+| Units | Fleet table, ticket backlog, provider rate meters |
+| Commands | Durable decision inbox: answer, revise, retry delivery |
+| Build Order | Ticket dependency graph and phases |
+| Analytics | Throughput, complexity tiers, and spend over a chosen window |
+
+Writable mode is the default and requires `AIUR_DASHBOARD_USERNAME` and
+`AIUR_DASHBOARD_PASSWORD`, even on loopback. Set
+`observability.dashboard_writable: false` for an unauthenticated read-only
+loopback dashboard. Basic Auth is unencrypted, so put a TLS proxy in front of any
+non-loopback bind.
+
+### Stream Deck
+
+An Elgato Stream Deck + can drive the fleet: agent keys ranked by urgency, pause
+and resume, a live log surface, and hold-to-dictate voice messages. A browser
+emulator of the same layout is at `/streamdeck` on the dashboard.
+
+> The physical sidecar is **experimental** and ships separately from this
+> package, as a Linux x64 archive (glibc 2.28+, systemd user session). It is not
+> installed by `npm install aiur-cli`. See the
+> [Stream Deck guide](https://aiur.team/docs/guide/stream-deck).
+
+## Update notices
+
+When a newer `aiur-cli` is published, a one-line notice is printed to stderr,
+checked in the background at most once a day and never blocking your command.
+Set `AIUR_NO_UPDATE_NOTIFIER=1` to silence it; it is skipped under CI.
+
+Prerelease builds are published under the `nightly` dist-tag and never reach
+`latest`, so a plain `npm install -g aiur-cli` always gives you a stable release.
+To try one: `npm install -g aiur-cli@nightly`.
 
 ---
 
 _Command macro, delegate micro, maximize APM._
 
-[github.com/its-everdred/aiur](https://github.com/its-everdred/aiur)
+[github.com/aiur-team/aiur](https://github.com/aiur-team/aiur)

package/bin/aiur.js

@@ -50,7 +50,7 @@ function resolveReleaseDir() {
     fail(
       `unsupported platform ${process.platform}/${process.arch}. ` +
         "Supported: darwin/linux on arm64/x64. " +
-        "See https://github.com/its-everdred/aiur",
+        "See https://github.com/aiur-team/aiur",
     );
   }
 
@@ -64,7 +64,7 @@ function resolveReleaseDir() {
         `platform package "${pkg}" is not installed. ` +
           "This usually means optional dependencies were skipped " +
           "(--no-optional, a shared lockfile, or a known npm install bug). " +
-          "Reinstall aiur-cli, or see https://github.com/its-everdred/aiur",
+          "Reinstall aiur-cli, or see https://github.com/aiur-team/aiur",
       );
     }
     throw err;
@@ -162,8 +162,9 @@ function ensureTmux() {
   }
 }
 
-// True only when the pinned opencode is on PATH; a wrong version (e.g. 1.17.x,
-// which broke the panes) must be replaced, so presence alone isn't enough.
+// True only when the pinned opencode is on PATH; a wrong (e.g. newer,
+// unverified) version must be replaced with the pin, so presence alone
+// isn't enough.
 function opencodeMatchesPin() {
   const result = safeSpawn("opencode", ["--version"], { encoding: "utf8" });
   return !result.error && result.status === 0 && (result.stdout || "").trim() === opencodeVersion();