Skip to main content

TypeScript SDK

@fleetforge/sdk ships typed clients for browser, Node, and edge runtimes. The API surface is generated from api/proto/public and the JSON Schemas under api/schemas/.

Install​

pnpm add @fleetforge/sdk
# or
npm install @fleetforge/sdk

Docs​

  • Generated reference: run pnpm -C website docs:typescript to refresh website/docs/reference/typescript/.
  • Usage guides live under docs/how-to and the /reference/adapters page.

Development workflow​

  1. Update schemas/protos.
  2. pnpm -C website docs:typescript to regenerate the Markdown docs.
  3. pnpm -C docs start (or build) to verify the sidebar picks up the updates.

Keep breaking changes documented in the changelog and the Roadmap & Status page.