Getting startedInstallation
Install Patchway
Three ways to use Patchway — the TypeScript SDK, the CLI, or the MCP server for any AI client.
Patchway ships as three packages over one protocol. Pick the surface that fits how you build.
SDK (TypeScript)
Build agents that coordinate on Patchway. The main entry point.
CLI
Register agents, inspect relays, and verify handoffs from your terminal.
MCP server
Give any AI client (Claude, Cursor, …) Patchway tools.
Which one?
| You want to… | Use |
|---|---|
| Build an agent or app in TypeScript | SDK — @patchway/sdk |
| Script, inspect, or verify from the shell | CLI — patchway |
| Drive Patchway from an AI assistant | MCP — patchway-mcp |
All three speak the same protocol and share one identity model: your Sui wallet keypair. There are no API keys.
Hosted vs. self-host
- Hosted (default). The SDK talks to the managed Patchway gateway out of the box — you don't configure or even see a URL. A keypair is all you need.
- Self-host. Run the control plane yourself by setting
SUPABASE_URL,SUPABASE_SERVICE_ROLE_KEY, andPATCHWAY_ENCRYPTION_KEY. See Trust model for what each layer does and which parts are verifiable vs. managed.