Quickstart

Prerequisites

• Node.js 22 or newer
• pnpm 10 or newer for this documentation repository
• npm and a local Postgres database for the platform repository

Run the API

From the Trellis platform checkout:

npm install
npm run db:setup
npm run dev

The API listens on http://localhost:3000 by default.

Run the documentation

From this repository:

pnpm install
pnpm dev

Open http://localhost:3001/docs. The documentation uses port 3001 so the interactive API reference can target the local API on port 3000.

Confirm the API is available

curl http://localhost:3000/

The response includes platform discovery information and service status.

Refresh the API reference

First export the current contract from the platform repository:

npm run export:openapi

Then sync and regenerate it from this repository:

pnpm openapi:sync
pnpm docs:generate

If your platform checkout is elsewhere, pass the schema path explicitly:

pnpm openapi:sync -- /path/to/trellis-platform/docs/openapi.json
pnpm docs:generate