Skip to content

Clarify CUA harness usage #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rgarcia merged 1 commit into from
May 13, 2026
Merged

Clarify CUA harness usage #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,13 @@ const transcript = harness.getTranscript();
console.log("messages in transcript:", transcript.length);
```

Use `CuaAgent` when you want direct pi `Agent` control. Use `CuaHarness` when you
want the harness-style constructor plus transcript-oriented helpers like
Use `CuaAgent` when you want direct pi `Agent` control: raw transcript state,
lifecycle events, custom streaming, and explicit prompt/continue/queue control.
Reach for the harness shape when you want an app layer around the loop:
session/transcript helpers, resource and prompt entry points, provider/auth
hooks, active tool selection, compaction/tree workflows, and higher-level queue
events. `CuaHarness` is the thin CUA version of that shape today: it installs
CUA defaults, delegates runtime methods to the wrapped `Agent`, and adds
`getTranscript()`.

## Core Concepts
Expand Down
Loading