CLI Reference

pnpm add -D @routegraph/cli

Every command falls back to plain, colorless, non-animated output automatically when stdout isn’t a TTY — CI logs stay readable without a flag.

routegraph init

Scaffold a new project.

routegraph init --name my-api          # interactive wizard
routegraph init --name my-api --yes    # defaults: Express, port 3000, every feature, pnpm

routegraph dev

Dev server: hot reload + docs UI (where auto-mounted — see Integrations).

routegraph dev
routegraph dev --port 4000

routegraph build

Validate → typecheck → generate RouteMap → export docs + OpenAPI. The command you put in CI before a deploy.

routegraph build

Exit code 1 on any validation or typecheck failure — safe to gate a pipeline on.

routegraph routes

Print every registered route as a table. Useful for a quick sanity check after a refactor.

routegraph routes

  GET      /health
  GET      /users
  POST     /users
  GET      /users/:id
  DELETE   /users/:id

routegraph validate

Check every route file’s exports and config shape without starting a server.

routegraph validate
routegraph validate --strict   # also fail on routes with no config (unvalidated)

routegraph generate-client

Writes the RouteMap type file @routegraph/client consumes.

routegraph generate-client --out ./routemap.ts

routegraph export-docs

Export a static docs site or an OpenAPI spec — no running server required.

routegraph export-docs --out ./dist/docs
routegraph export-docs --format openapi --out ./openapi.json