mirror of
https://github.com/getpaseo/paseo.git
synced 2026-10-14 13:22:37 +00:00
Mohamed Boudra
7954babca6
* feat(client): publish the TypeScript SDK surface Make the high-level client API usable for external integrations and document complete agent, workspace, provider, event, and recipe flows. * fix(client): correlate provider snapshots by daemon cwd Return the daemon's canonical snapshot identity so waitForReady can match updates for relative, tilde, and otherwise non-canonical paths without duplicating filesystem rules in the SDK. * test(server): make snapshot cwd assertion portable * fix(client): gate canonical provider snapshot waits Older daemons do not expose the canonical snapshot identity needed to correlate workspace updates safely. Require the advertised capability and fail with an update-host message instead of guessing across workspaces.
2.6 KiB
2.6 KiB
title, description, nav, order, category
| title | description | nav | order | category |
|---|---|---|---|---|
| SDK quickstart | Connect to a Paseo daemon, run one coding agent, and read its reply. | Quickstart | 51 | TypeScript SDK |
SDK quickstart
npm install @getpaseo/client
Requires Node.js 22 or newer.
Connect
import { createPaseoClient } from "@getpaseo/client";
const client = createPaseoClient({ url: "ws://127.0.0.1:6767/ws" });
await client.connect();
connect() resolves once the daemon has identified itself. If the daemon has a password, pass it:
const client = createPaseoClient({
url: "wss://devbox.example.com/ws",
password: "my-secret",
});
Create an agent
const agent = await client.agents.create({
config: { provider: "codex/gpt-5.5" },
cwd: "/Users/me/dev/storefront",
prompt: "Review the current diff and name the riskiest change.",
});
config.provider is always provider/model. Providers lists what the daemon has available and how to discover it at runtime.
cwd is the directory the agent works in. Paseo creates the workspace behind it. Workspaces covers reusing one instead.
create() resolves as soon as the session exists. The prompt is still running.
Wait for the reply
const result = await agent.waitForFinish();
if (result.status === "idle") {
console.log(result.lastMessage);
}
waitForFinish() waits up to 10 minutes by default; pass milliseconds to change it. It returns one of four statuses:
| Status | Meaning |
|---|---|
idle |
The turn finished and the agent can take another prompt. |
permission |
The agent needs a person to answer a permission request in Paseo. |
error |
The provider ended the turn with an error. |
timeout |
The deadline elapsed. The agent is still running. |
Disconnect
await client.close();
The agent keeps running on the daemon and stays visible in Paseo. A later program reaches it again by ID:
const agent = client.agents.ref("agent_01H8X...");
await agent.refresh();
await agent.run("Now write the fix.");
Next
- Agents, follow-up prompts, finding existing agents, archiving.
- Providers, discovering models and modes from the daemon.
- Provider options, sandboxing and provider-native settings.
- Workspaces, reusing a workspace or creating a worktree.
- Events, streaming updates instead of waiting.