mirror of
https://github.com/getpaseo/paseo.git
synced 2026-10-23 17:52:49 +00:00
Mohamed Boudra
18aaec2772
Move supported protocol capabilities into client defaults and make session traffic subscription-driven. Preserve timeline readiness and reconnect recovery across SDK, CLI, and plugin consumers.
45 lines
1.8 KiB
Markdown
45 lines
1.8 KiB
Markdown
# @getpaseo/client
|
|
|
|
TypeScript SDK for building integrations on top of a Paseo daemon.
|
|
|
|
```bash
|
|
npm install @getpaseo/client
|
|
```
|
|
|
|
```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();
|
|
```
|
|
|
|
The public API is the package root. Imports under `@getpaseo/client/internal/*` are unsupported implementation details used by Paseo's own packages.
|
|
|
|
Read the [SDK documentation](https://paseo.sh/docs/sdk) for agents, workspaces, terminals, provider discovery, events, recipes, and the API reference. Runnable TypeScript patterns also live in [`examples/`](./examples/README.md).
|
|
|
|
## Runtime
|
|
|
|
The client needs a WebSocket implementation. Modern browsers and Node.js 22 provide one globally.
|
|
|
|
Use a WebSocket URL ending in `/ws`, such as `ws://127.0.0.1:6767/ws`. Pass `password` when the daemon requires authentication.
|
|
|
|
The client advertises its supported protocol capabilities by default. Optional `capabilities`
|
|
overrides extend or override that declaration; browser hosting must be supplied by the caller.
|
|
Connecting alone does not subscribe to agent timelines or catalog events. See the
|
|
[event guide](https://paseo.sh/docs/sdk/events) for subscription lifetimes and timeline replacements.
|
|
|
|
## Stability
|
|
|
|
The high-level API exported from `@getpaseo/client` is the supported SDK surface. The SDK and daemon remain protocol-compatible across versions, but newly added capabilities can require a newer daemon.
|