runspur 0.1.1 → 0.1.2

package/README.md

@@ -1,35 +1,38 @@
 # Runspur CLI
 
-Runspur lets Codex and Claude Code delegate work to each other and sends results back to the conversation that started the task. This npm package contains the Windows x64 daemon, CLI, and MCP bridge as native executables.
+Runspur lets Codex and Claude Code delegate work to each other and sends results back to the conversation that started the task. The Windows x64 npm package includes the Runspur CLI, scheduler, MCP bridge, and local browser panel.
 
 ## Install
 
 With Node.js and npm installed, run the following in PowerShell.
 
 ```powershell
-npm.cmd install --global runspur
-schedulerd.cmd --version
-schedulerctl.cmd --help
-scheduler-mcp.cmd --help
+npm install --global runspur
+runspur --version
 ```
 
-## Connect a project
+If PowerShell blocks script shims, use `npm.cmd` and `runspur.cmd`.
 
-Start `schedulerd.cmd` in one terminal and keep it running. In another terminal, point the CLI at an existing project folder. Review the first command's preview, then save with `--apply`.
+## Open the panel
+
+Run the following to open the panel in your browser. Runspur starts the local scheduler as needed.
 
 ```powershell
-$project = 'D:\path\your-project'
-schedulerctl.cmd configure --project-root $project --main-agent codex
-schedulerctl.cmd configure --project-root $project --main-agent codex --apply
-schedulerctl.cmd doctor --project-root $project
+runspur tui
 ```
 
-Open a new conversation in the configured host so it can discover the Skill and MCP tools. Automatic result delivery is verified on the supported Codex desktop distribution and on native Claude Code CLI sessions. Claude Code requires version 2.1.319 or later. Claude Desktop is untested.
+In **Projects**, add an existing folder and select the main Agent, child Agents, and file permissions. Review the configuration and confirm to connect the project. Open a new conversation in the configured host to load the project's Skill and MCP tools.
+
+Automatic result delivery is verified on the supported Codex desktop distribution and on native Claude Code CLI sessions. Claude Code requires version 2.1.319 or later. Claude Desktop is untested.
+
+For headless use, run `runspur start` to start the scheduler in the background and `runspur stop` to stop it. Each command returns when the scheduler reaches the requested state.
+
+## Manage projects and dispatches
 
-The default `probe` worker is for diagnostics. Set `--workers claude-cli` to use an installed Claude Code worker with a Codex main Agent. To switch roles, use `--main-agent claude-code --workers codex-cli`. Worker access starts read-only. With a supported Claude Code worker, use `--permission workspace-write` for task-specific files or `--permission project-write` for text files across the isolated project workspace. Preview and apply edits with `configure`.
+Use **Projects** to edit the Agents or permissions of a connected project. Worker access defaults to read-only. Use Claude Code **2.1.319** for workers that need permission to edit task-specific files or text files across the isolated project workspace.
 
-Use `schedulerctl.cmd projects`, `sessions --project <project-id>`, and `tasks --project <project-id>` to locate a dispatch. Use `schedulerctl.cmd task <task-id>` to inspect its result and delivery status.
+Use **Dispatch history** to find tasks by project and conversation, then inspect their results and delivery status.
 
-Stop the Runspur processes before updating with `npm.cmd update --global runspur` or removing the package with `npm.cmd uninstall --global runspur`. Project settings and the Runspur state directory are stored separately.
+Before uninstalling, finish active tasks and close connected Agent conversations. Stop the scheduler from **Overview** or run `runspur stop`. If the panel is open, press Ctrl+C in the `runspur tui` terminal to close it. Then run `npm uninstall --global runspur`. Project settings and the Runspur state directory are stored separately.
 
 [Full usage and source](https://github.com/ohmacemace/runspur) · [简体中文](https://github.com/ohmacemace/runspur/blob/main/docs/README.zh-CN.md)