mirror of https://github.com/getpaseo/paseo.git synced 2026-10-24 02:02:42 +00:00

Files

T

Michael Vandesompel 2bf69e6d8e Let readFile callers disable the request timeout

readFile resolves only when FileEnd arrives, so the default 60 s request
timeout bounds the whole transfer. A large file over a slow relay fails
before it finishes even though every chunk is arriving. Thread an optional
timeout through requestFileExplorer; 0 disables the timer, as the
workspace.create request already does, and a dead connection still rejects
on disconnect.

The relay e2e case reads a 1 MiB file through a real daemon and a local
relay with timeout 0 and compares SHA-256 digests with the source.

2026-10-14 14:15:11 +02: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

src

Let readFile callers disable the request timeout

2026-10-14 14:15:11 +02:00

package.json

fix(ios): address clipped chat and Markdown text (#6445 )

2026-10-09 16:35:43 +01: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.