mirror of https://github.com/getpaseo/paseo.git synced 2026-11-10 18:35:17 +00:00

Files

T

Mohamed Boudra 457d8d6ec5 Merge origin/main into plan-provider-switch-sqlite-timelines

Adapts main's changes to the single asynchronous timeline owner:

- The subscribe freshness check (#9175) awaits the loaded timeline head and
  compares the client's cursor against the epoch that client sees, so legacy
  clients compare against their derived epoch after a rewind.
- History reads (#8737) pass purpose "history" when an agent with no stored
  timeline must be loaded; stored history is still read without the provider.
- Background work clears on reload, close and parent delete next to the
  async provider-child cancellation.
- Claude steered-message rewinds (#8372) report an at-target cut. Codex keeps
  main's saved thread id alongside the reported cut.
- Plugin rewinds (#8368) return an unreported outcome; a failed replay after
  the native revert leaves the rewind for the reload to settle rather than a
  retry. Manager-level rewinds target the timeline row's message id.
- Main's tests read the timeline asynchronously, and wait for the provider to
  receive a prompt instead of assuming it arrives in the dispatch tick.

2026-11-10 13:47:17 +01:00

examples

fix(client): let SDK callers choose what a send does to an active turn (#5605 )

2026-09-29 06:53:14 +02:00

scripts

feat(diff): stream Changes revisions without blocking the socket (#8907 )

2026-11-08 11:00:21 +07:00

src

Merge origin/main into plan-provider-switch-sqlite-timelines

2026-11-10 13:47:17 +01:00

LICENSE

fix(npm): declare and ship Apache-2.0 licenses (#7816 )

2026-11-03 11:54:57 +00:00

package.json

chore(release): reconcile 0.15.4 into main (#9240 )

2026-11-10 08:50:23 +07:00

README.md

fix(client): keep daemon connections lean by default (#4470 )

2026-09-08 12:59:25 +02:00

tsconfig.examples.json

Extract client SDK package (#1052 )

2026-05-28 01:58:18 +08:00

tsconfig.json

Extract client SDK package (#1052 )

2026-05-28 01:58:18 +08:00

README.md

@getpaseo/client

TypeScript SDK for building integrations on top of a Paseo daemon.

npm install @getpaseo/client

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 for agents, workspaces, terminals, provider discovery, events, recipes, and the API reference. Runnable TypeScript patterns also live in examples/.

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 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.