toll-free-harness 0.1.0

package/LICENSE

@@ -0,0 +1,199 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format.
+
+   Copyright 2026 WeZZard
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/MIGRATION.md

@@ -0,0 +1,283 @@
+# Migrating from `claude -p` to toll-free-harness
+
+This guide shows how to convert scripts that use `claude -p` (with `--output-format json`, `--output-format stream-json`, or `--input-format stream-json`) to the toll-free-harness library API. Each section shows a Before (shell command) and After (TypeScript using toll-free-harness).
+
+## 1. Simple prompt
+
+### Before
+
+```bash
+claude -p "Fix the failing tests" --model opus
+```
+
+### After
+
+```typescript
+import { ClaudeCodeSession } from "toll-free-harness";
+
+const session = new ClaudeCodeSession({
+  args: ["--model", "opus"],
+  cwd: process.cwd(),
+  prompt: "Fix the failing tests",
+});
+
+const result = await session.run();
+console.log(`Exit code: ${result.exitCode}`);
+```
+
+The `prompt` option replaces the positional argument to `claude -p`. Additional CLI flags go in `args`.
+
+## 2. JSON output (`--output-format json`)
+
+With `claude -p --output-format json`, you get a single JSON blob after the session finishes. The typical use is to capture what tools ran and the final result.
+
+### Before
+
+```bash
+result=$(claude -p "Fix the failing tests" --output-format json)
+echo "$result" | jq '.result'
+```
+
+### After
+
+```typescript
+import { ClaudeCodeSession } from "toll-free-harness";
+
+const toolResults: Array<{ tool: string; input: unknown }> = [];
+
+const session = new ClaudeCodeSession({
+  args: ["--model", "opus"],
+  cwd: process.cwd(),
+  prompt: "Fix the failing tests",
+});
+
+// Collect tool results as they complete (replaces parsing the JSON blob)
+session.onPostToolUse("*", (event) => {
+  toolResults.push({
+    tool: event.toolName ?? "unknown",
+    input: event.toolInput,
+  });
+});
+
+// Capture the final stop event (replaces reading .result from the JSON)
+let stopPayload: Record<string, unknown> = {};
+session.onStop((payload) => {
+  stopPayload = payload;
+});
+
+const result = await session.run();
+console.log("Tools used:", toolResults);
+console.log("Stop payload:", stopPayload);
+console.log("Exit code:", result.exitCode);
+```
+
+Instead of parsing a JSON blob after the fact, you receive structured events as they happen through `onPostToolUse` and `onStop`.
+
+## 3. Stream-json output (`--output-format stream-json`)
+
+With `claude -p --output-format stream-json`, you get newline-delimited JSON events as the session runs. The typical use is to observe tool calls in real time.
+
+### Before
+
+```bash
+claude -p "Refactor the auth module" --output-format stream-json | while read -r line; do
+  type=$(echo "$line" | jq -r '.type')
+  case "$type" in
+    tool_use)
+      tool=$(echo "$line" | jq -r '.tool')
+      echo "Using tool: $tool"
+      ;;
+    tool_result)
+      tool=$(echo "$line" | jq -r '.tool')
+      echo "Tool done: $tool"
+      ;;
+    result)
+      echo "Finished"
+      ;;
+  esac
+done
+```
+
+### After
+
+```typescript
+import { ClaudeCodeSession } from "toll-free-harness";
+
+const session = new ClaudeCodeSession({
+  args: ["--model", "opus"],
+  cwd: process.cwd(),
+  prompt: "Refactor the auth module",
+});
+
+// Fires before each tool call (replaces stream-json tool_use events)
+session.onPreToolUse("*", (event) => {
+  console.log(`Using tool: ${event.toolName}`);
+  if (event.toolName === "Bash") {
+    console.log(`  Command: ${(event.toolInput as Record<string, unknown>)?.command}`);
+  }
+});
+
+// Fires after each tool call (replaces stream-json tool_result events)
+session.onPostToolUse("*", (event) => {
+  console.log(`Tool done: ${event.toolName}`);
+});
+
+// Fires when the session ends (replaces stream-json result event)
+session.onStop(() => {
+  console.log("Finished");
+});
+
+const result = await session.run();
+```
+
+You can also filter listeners by tool name instead of matching on `"*"`:
+
+```typescript
+session.onPreToolUse("Bash", (event) => {
+  console.log(`Running command: ${(event.toolInput as Record<string, unknown>)?.command}`);
+});
+
+session.onPreToolUse("Read", (event) => {
+  console.log(`Reading file: ${(event.toolInput as Record<string, unknown>)?.file_path}`);
+});
+```
+
+## 4. Stream-json input (`--input-format stream-json`)
+
+With `claude -p --input-format stream-json`, you pipe structured messages into the agent and handle its questions and plan reviews programmatically.
+
+### Before
+
+```bash
+# Pipe a prompt and handle conversation interactively
+echo '{"type":"user","content":"Refactor the auth module"}' | \
+  claude -p --input-format stream-json --output-format stream-json | \
+  while read -r line; do
+    type=$(echo "$line" | jq -r '.type')
+    if [ "$type" = "ask_user_question" ]; then
+      # Pick the first option
+      echo '{"type":"user","content":"1"}'
+    elif [ "$type" = "plan" ]; then
+      # Approve the plan
+      echo '{"type":"user","content":"yes"}'
+    fi
+  done
+```
+
+### After
+
+```typescript
+import { ClaudeCodeSession } from "toll-free-harness";
+
+const session = new ClaudeCodeSession({
+  args: ["--model", "opus"],
+  cwd: process.cwd(),
+  prompt: "Refactor the auth module",
+});
+
+// Handle the agent's questions (replaces parsing ask_user_question and sending a choice)
+session.onAskUserQuestion(async (event) => {
+  console.log(`Question: ${event.text}`);
+  for (const q of event.questions) {
+    console.log(`  Options: ${q.options.map((o) => o.label).join(", ")}`);
+  }
+  // Select the first option (0-indexed)
+  return { selectedIndex: 0 };
+});
+
+// Handle plan review (replaces parsing plan events and sending yes/no)
+session.onExitPlanMode(async (event) => {
+  console.log(`Plan: ${event.planText.slice(0, 200)}...`);
+  // Approve the plan
+  return { decision: "approve" };
+});
+
+const result = await session.run();
+```
+
+To reject a plan and provide feedback:
+
+```typescript
+session.onExitPlanMode(async (event) => {
+  if (event.planText.includes("delete")) {
+    return { decision: "reject", feedback: "Do not delete any files." };
+  }
+  return { decision: "approve" };
+});
+```
+
+To send follow-up prompts after the initial run:
+
+```typescript
+const session = new ClaudeCodeSession({
+  args: ["--model", "opus"],
+  cwd: process.cwd(),
+  prompt: "Fix the failing tests",
+});
+
+session.onStop(() => {
+  // Send a follow-up prompt when the first task finishes
+  session.sendPrompt("Now add tests for the fix");
+});
+
+// sendPrompt also supports attaching images
+session.sendPrompt("What does this UI look like?", {
+  images: ["/tmp/screenshot.png"],
+});
+```
+
+## 5. Feature comparison
+
+| Capability | `claude -p` | toll-free-harness |
+|---|---|---|
+| Run a prompt | `claude -p "prompt"` | `new ClaudeCodeSession({ prompt })` then `session.run()` |
+| Get final result | `--output-format json` | `session.onStop(callback)` |
+| Stream tool events | `--output-format stream-json` | `session.onPreToolUse` / `session.onPostToolUse` |
+| Answer questions | `--input-format stream-json` + manual parsing | `session.onAskUserQuestion(handler)` |
+| Review plans | `--input-format stream-json` + manual parsing | `session.onExitPlanMode(handler)` |
+| Send follow-up prompts | Not supported | `session.sendPrompt(text, options?)` |
+| Attach images | Not supported | `session.sendPrompt(text, { images: [...] })` |
+| Filter by tool name | Parse JSON and check `.tool` field | `session.onPreToolUse("Bash", callback)` |
+| Wait for specific events | Manual loop over stream | `session.guardrail.expect({ kind, toolName }, timeout)` |
+| Typed event payloads | Raw JSON | `AskUserQuestionEvent`, `ExitPlanModeEvent`, `HookRequest` |
+| Permission observation | Parse stream events | `session.onPermissionRequest(toolName, callback)` |
+| Multi-turn conversation | Requires external orchestration | Built-in via `sendPrompt` |
+
+## 6. Installation
+
+```bash
+npm install toll-free-harness node-pty
+```
+
+Or with pnpm:
+
+```bash
+pnpm add toll-free-harness node-pty
+```
+
+`node-pty` is a peer dependency that provides the PTY (pseudo-terminal) used to spawn the agent. It requires a native build toolchain (Xcode command-line tools on macOS, build-essential on Linux).
+
+## 7. Event guardrail for deterministic flows
+
+If your `claude -p` script waited for specific tool calls before proceeding, use the guardrail API:
+
+```typescript
+// Wait for a specific tool call with a timeout
+const event = await session.guardrail.expect(
+  { kind: "pre_tool_use", toolName: "Bash" },
+  10_000, // 10 second timeout
+);
+console.log("Bash tool was called:", event.payload);
+```
+
+This replaces patterns like:
+
+```bash
+claude -p "..." --output-format stream-json | while read -r line; do
+  tool=$(echo "$line" | jq -r '.tool')
+  if [ "$tool" = "Bash" ]; then
+    echo "Got it"
+    break
+  fi
+done
+```

package/README.md

@@ -0,0 +1,127 @@
+# toll-free-harness
+
+Full-featured user interaction simulator for terminal-based coding agents.
+
+`toll-free-harness` models the complete user interaction surface of a coding agent CLI — prompting, answering questions, reviewing plans — as typed APIs. It spawns the agent in a local PTY, observes events through read-only hooks, and responds through the same keystroke channel a real user would.
+
+Currently supports **Claude Code**. The framework is designed to add support for other coding agents whose headless modes do not fully expose the interactive user experience.
+
+The name is a joke about toll booths around developer workflows.
+
+## What this project is not
+
+Not an API proxy, credential-sharing service, or billing workaround. Users run their own local tools with their own accounts and must comply with those tools' terms.
+
+## Install
+
+```bash
+pnpm add toll-free-harness node-pty
+```
+
+## Quick start
+
+```typescript
+import { ClaudeCodeSession } from "toll-free-harness";
+
+const session = new ClaudeCodeSession({
+  args: ["--model", "opus"],
+  cwd: "/path/to/project",
+  prompt: "Fix the failing tests",
+});
+
+// Handle the agent's questions — return which option to select
+session.onAskUserQuestion(async (event) => {
+  console.log(event.text);
+  console.log(event.questions[0]?.options.map((o, i) => `${i}: ${o.label}`));
+  return { selectedIndex: 0 };
+});
+
+// Handle plan review — approve or reject with feedback
+session.onExitPlanMode(async (event) => {
+  console.log(event.planText.slice(0, 200));
+  return { decision: "approve" };
+});
+
+const result = await session.run();
+
+// Send a follow-up prompt (with optional images)
+session.sendPrompt("Now add tests for the fix", {
+  images: ["/tmp/screenshot.png"],
+});
+```
+
+## User interactions
+
+The framework models three user interactions as dedicated typed APIs:
+
+| Interaction | API | You provide | Library does |
+|---|---|---|---|
+| **Prompting** | `sendPrompt(text, options?)` | Text + optional image paths | Injects keystrokes into PTY |
+| **Answering questions** | `onAskUserQuestion(handler)` | `{ selectedIndex }` | Navigates and selects the option |
+| **Reviewing plans** | `onExitPlanMode(handler)` | `{ decision: "approve" }` or `{ decision: "reject", feedback }` | Approves or rejects via keystrokes |
+
+There is no raw `write()` — the library translates your typed decisions into the correct keystrokes internally.
+
+## Hook listeners (read-only)
+
+Observe agent events without sending data back:
+
+```typescript
+session.onPreToolUse("Bash", (event) => {
+  console.log(`Running: ${event.toolInput?.command}`);
+});
+
+session.onPostToolUse("*", (event) => {
+  console.log(`Tool ${event.toolName} completed`);
+});
+
+session.onStop(() => {
+  console.log("Session ended");
+});
+```
+
+Available: `onPreToolUse`, `onPostToolUse`, `onPermissionRequest`, `onStop`, `onUserPromptSubmit`. All are read-only — hooks return `{}` internally and never send data back to the agent.
+
+## Event guardrail
+
+Wait for specific events with timeouts for deterministic test flows:
+
+```typescript
+const event = await session.guardrail.expect(
+  { kind: "pre_tool_use", toolName: "Bash" },
+  10_000,
+);
+```
+
+## Timing model
+
+`PreToolUse` and `Stop` hooks are **blocking** — the agent waits for them. Keystrokes injected during a blocking hook callback buffer in PTY stdin and are consumed by the UI after the hook returns. `PermissionRequest` is **non-blocking** — the dialog renders in parallel.
+
+## How it works
+
+1. `run()` generates a temporary plugin in `/tmp/toll-free-plugin-<uuid>/` containing a manifest, hook definitions, and a bundled hook client
+2. Starts an HTTP server on a Unix domain socket (`/tmp/toll-free-<uuid>.sock`)
+3. Spawns the agent in a PTY with `--plugin-dir /tmp/toll-free-plugin-<uuid>/` plus your args and prompt
+4. The agent loads the plugin and fires hooks as it runs. The hook client posts events to the socket.
+5. Your interaction handlers and listeners receive events; responses go through PTY keystrokes
+6. On exit, the socket and plugin directory are cleaned up
+
+No user-scope settings are modified. The plugin is self-contained and session-scoped.
+
+## Cross-platform
+
+Uses Node.js `http.request({ socketPath })` for IPC — works on macOS, Linux, and Windows 10 1803+.
+
+## Migrating from claude -p
+
+Ask your coding agent to help you migrate:
+
+```
+curl -s https://raw.githubusercontent.com/WeZZard/toll-free-harness/main/MIGRATION.md | pbcopy
+```
+
+Paste the content to your agent and ask it to convert your `claude -p` scripts to use toll-free-harness.
+
+## License
+
+Apache-2.0