@warlock.js/ai-cli 0.0.0-stage → 5.31.0

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog — @warlock.js/ai-cli
+
+All notable changes to `@warlock.js/ai-cli` are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). `@warlock.js/*` packages are released in lockstep — every package shares the same version number, so a version below may list only the changes that affected this package.
+
+## 5.31.0 - 2026-10-18
+
+### Added
+
+- First release: drive vendor coding-agent CLIs headless as agents. `cli.<vendor>(options)` (also `ai.cli.<vendor>` after importing the package) returns a CLI agent. `run(prompt, { cwd, resume, signal, timeoutMs, model, effort, permission, mcp, env, apiKey, args })` starts one session, and returns `CliSession` with `events`, `done()` and `cancel()`.
+- Adapters for Claude Code, Codex, Antigravity, Qwen Code, Kimi Code, Cursor, Copilot, Grok Build, OpenCode, Amp, Factory Droid, Mistral Vibe, Aider and Reasonix. Each records the CLI version, the official sources, and whether it was verified against the real `--help` or against the docs (`adapter.verification`).
+- One event model for every vendor: `session.started`, `message` (deltas and complete messages), `tool.call`, `tool.result`, `usage`, `error` and `session.ended`. `session.done()` resolves `{ status, text, messages, usage, sessionRef, exitCode, signal, error, stderr, durationMs }` and never rejects.
+- Capability probe: before the first run, the CLI's `--version` and help screens are read, and every flag the launch plan relies on must be listed. A missing flag fails the run with `CliError` (`type: "capability"`), naming the flag and the installed version.
+- Secrets never go to argv:
+  - API keys travel in the environment (`apiKey`).
+  - Per-run MCP servers are written as a mode-0600 file in a private per-run directory, removed after the run.
+  - Each run gets a private config home by default (`CLAUDE_CONFIG_DIR`, `CODEX_HOME`, `COPILOT_HOME`, `GROK_HOME`, …). `home` also takes a path you own, or `"inherit"`.
+- `permission` defaults to `"standard"`, the CLI's own non-interactive approval rules. Each vendor's approve-everything mode is used only with `permission: "bypass"`.
+- Windows spawn rules:
+  - `PATHEXT` lookup.
+  - npm and pnpm `.cmd` shims are unwrapped to `node <script>` (or their native `.exe`).
+  - Other batch files fall back to `cmd.exe /d /v:off /s /c` with every argument quoted, refusing bytes `cmd.exe` cannot carry.
+  - The prompt moves to stdin or a prompt file when argv cannot carry it.
+- Cancellation (`signal`, `cancel()`) and `timeoutMs` kill the CLI's whole process tree. On POSIX this is its own process group, with SIGTERM then SIGKILL; on Windows, `taskkill /T /F` on its PID.
+- `agent.model(config)` / `cliModel(agent, config)` wraps a CLI agent as a `ModelContract`, so `ai.agent` and its budget, guardrail, observer and fallback middleware can drive a CLI.
+- `createCliAgent(adapter, options)` / `cli.custom(adapter)` and the documented `CliAdapter` interface let apps add vendors. The building blocks are exported: `jsonLinesParser`, `createClaudeStreamParser`, `mcpServersJson`, `toToml`, `mapEffort`, `requirePrivateHome` and more.
+
+### Fixed
+
+- `session.cancel()`, or aborting the run's `signal`, after the run has finished no longer signals the CLI's old process group. Once the CLI's pipes close, cancellation is a no-op, so a `finally { session.cancel() }` cannot reach an unrelated process that reused the pid. The abort listener is also removed when the run settles.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Hassan Zohdy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,70 @@
-# Temporary Holding Version
+# @warlock.js/ai-cli
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+> Drive vendor coding-agent CLIs (Claude Code, Codex, Copilot, Cursor, Grok, …) as first-class `@warlock.js/ai` agents.
+
+Many teams run the vendors' own agent CLIs on the subscriptions they already pay for. This package launches those CLIs headless and reduces each vendor's stream to **one event model**. You get resume, process-tree cancellation, usage, per-run MCP servers, and an `ai.agent` model adapter.
+
+Built-in adapters, each one verified against the CLI's real `--help` or its official docs:
+
+- Claude Code
+- Codex
+- Antigravity
+- Qwen Code
+- Kimi Code
+- Cursor
+- Copilot
+- Grok Build
+- OpenCode
+- Amp
+- Factory Droid
+- Mistral Vibe
+- Aider
+- Reasonix
+
+## Install
+
+```bash
+npm install @warlock.js/ai @warlock.js/ai-cli
+```
+
+The vendor CLIs are not dependencies; install the ones you use. The package itself uses only Node built-ins (`node:child_process`, `node:fs`).
+
+## Quick start
+
+```ts
+import { cli } from "@warlock.js/ai-cli";
+
+const claude = cli.claudeCode({ model: "sonnet", apiKey: process.env.ANTHROPIC_API_KEY });
+const session = await claude.run("Fix the failing test", { cwd: "/srv/acme-api" });
+
+for await (const event of session.events) {
+  if (event.type === "message" && event.delta) process.stdout.write(event.text);
+  if (event.type === "tool.call") console.log("\n→", event.name);
+}
+
+const { status, text, usage, sessionRef, exitCode } = await session.done();
+```
+
+Importing the package also registers `ai.cli` on the shared `ai` object. There is one factory per vendor: `cli.claudeCode`, `cli.codex`, `cli.antigravity`, `cli.qwenCode`, `cli.kimi`, `cli.cursor`, `cli.copilot`, `cli.grok`, `cli.opencode`, `cli.amp`, `cli.droid`, `cli.mistralVibe`, `cli.aider` and `cli.reasonix`. `cli.custom(adapter)` takes your own adapter.
+
+## What you get
+
+- **Events:** `session.started`, `message` (deltas or complete), `tool.call`, `tool.result`, `usage`, `error`, `session.ended`.
+- **Result:** `done()` resolves `{ status, text, messages, usage, sessionRef, exitCode, error, stderr }` and never rejects.
+- **Resume** with `{ resume: sessionRef }`. **Cancel** with `signal`, `session.cancel()` or `timeoutMs`; the CLI's whole process tree is killed.
+- **Permissions:** `"standard"` by default (the CLI's own non-interactive rules). Each vendor's approve-everything mode needs an explicit `permission: "bypass"`.
+- **Secrets never in argv:** API keys travel in the environment. MCP servers are written to a 0600 file in a private per-run directory. Each run gets a private config home by default (`CLAUDE_CONFIG_DIR`, `CODEX_HOME`, `COPILOT_HOME`, …).
+- **Capability probe:** the installed CLI's `--help` must list every flag the adapter uses, otherwise the run fails up front, naming the flag and the version.
+- **Windows:** `PATHEXT` lookup. npm `.cmd` shims run as `node <script>`; other batch files fall back to `cmd.exe` with safe quoting. The prompt moves to stdin when argv cannot carry it.
+- **`ai.agent` integration:** `cli.codex().model()` is a `ModelContract`, so budget, guardrail, observer and fallback middleware apply.
+
+## Documentation
+
+- [Run coding CLIs as agents](https://warlock.js.org/v/latest/ai/cli-agents/run-cli-agents/)
+- [Vendor adapters](https://warlock.js.org/v/latest/ai/cli-agents/vendors/) — flags, stream formats and verification per CLI
+- [Security and platforms](https://warlock.js.org/v/latest/ai/cli-agents/security-and-platforms/)
+- [Write an adapter](https://warlock.js.org/v/latest/ai/cli-agents/custom-adapter/)
+
+## License
+
+MIT