Mohamed BoudraandGitHub
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.
51 lines
1.5 KiB
Markdown
51 lines
1.5 KiB
Markdown
---
|
|
title: TypeScript SDK
|
|
description: Run Paseo coding agents from a TypeScript program.
|
|
nav: Overview
|
|
order: 50
|
|
category: TypeScript SDK
|
|
---
|
|
|
|
# TypeScript SDK
|
|
|
|
`@getpaseo/client` is a TypeScript library that drives a Paseo daemon from your own program. You pick a provider and model, give an agent a prompt and a directory, and wait for the answer.
|
|
|
|
The daemon does the work: it launches the provider CLI, keeps the session alive, and streams it to the Paseo app. Your program is a client. Agents you create show up in Paseo next to the ones you started by hand, and they stay there after your program exits.
|
|
|
|
Use it to:
|
|
|
|
- turn an issue, alert, or webhook into a coding task;
|
|
- run several agents in parallel and collect their answers;
|
|
- hold a session open and send follow-up prompts;
|
|
- build a dashboard over your agents.
|
|
|
|
## Start a daemon
|
|
|
|
```bash
|
|
npx @getpaseo/cli
|
|
```
|
|
|
|
It listens on `ws://127.0.0.1:6767/ws`.
|
|
|
|
## Run an agent
|
|
|
|
```ts
|
|
import { createPaseoClient } from "@getpaseo/client";
|
|
|
|
const client = createPaseoClient({ url: "ws://127.0.0.1:6767/ws" });
|
|
await client.connect();
|
|
|
|
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.",
|
|
});
|
|
|
|
const result = await agent.waitForFinish();
|
|
console.log(result.lastMessage);
|
|
|
|
await client.close();
|
|
```
|
|
|
|
[Quickstart](/docs/sdk/quickstart) walks through this line by line and covers passwords and remote daemons.
|