mirror of
https://github.com/getpaseo/paseo.git
synced 2026-10-14 21:32:40 +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.
22 lines
1.3 KiB
Markdown
22 lines
1.3 KiB
Markdown
# Paseo Client SDK Examples
|
|
|
|
These examples use only the public SDK root:
|
|
|
|
```ts
|
|
import { createPaseoClient, type PaseoClient } from "@getpaseo/client";
|
|
```
|
|
|
|
Each example takes the daemon WebSocket URL as an argument. In worktree dev, read it
|
|
from the portless banner or `portless get daemon`; for the desktop-managed daemon,
|
|
use the URL for that daemon.
|
|
|
|
- `quickstart.ts` runs one agent and prints its reply. It is a standalone script with the URL at the top; the rest export functions.
|
|
- `workspaces.ts` covers creating a fresh workspace, opening by directory, refreshing, and archiving.
|
|
- `agents-and-providers.ts` covers provider discovery, creating agents, and waiting for turns.
|
|
- `events-and-timeline.ts` covers subscribing to workspace, agent, and timeline events, plus refetching a timeline page.
|
|
- `issue-to-agent.ts` turns an issue record into a visible Paseo workspace and agent.
|
|
- `parallel-review.ts` launches several reviewers concurrently and cleans them up.
|
|
- `provider-settings.ts` covers provider settings that are currently daemon config-backed.
|
|
|
|
Provider profiles, provider env vars, custom binaries, and additional models are still raw daemon config behavior. The SDK exposes them through `client.config.get()` and `client.config.patch()` until first-class provider settings RPCs exist.
|