mirror of
https://github.com/getpaseo/paseo.git
synced 2026-11-04 07:33:18 +00:00
Mohamed Boudra
c8a417c4fb
* feat(terminals): expose workspace ownership through the SDK and CLI Directory-based terminal creation selected the oldest workspace sharing that path. Expose explicit workspace ownership in the shared public API and CLI, retain ownership and process directories in listings, and acknowledge terminal deletion after teardown. * fix(file-observer): preserve nested shallow reconciliation scopes A parent directory scan does not visit its descendants. Collapsing change scopes discarded nested scans and left coalesced native deletions unseen until a full audit. * test(terminals): extract output waits from end-to-end scenarios
40 lines
1.4 KiB
Markdown
40 lines
1.4 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.
|
|
|
|
## 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.
|