CLI

forge client --help

SUBCOMMANDS:
  generate        Generate a client from API specification
  check           Verify the committed client matches what the current spec generates
  watch           Regenerate the client whenever the API specification changes
  diff            Classify what changed between two API specifications
  list            List endpoints from specification
  init            Initialize client generation configuration

forge client generate \
  --from-spec ./openapi.json \
  --language typescript \
  --output ./src/generated \
  --package "@acme/orders-client" \
  --base-url "https://api.example.com" \
  --hooks

forge client check --from-spec ./openapi.json --output ./src/generated --hooks

EXIT CODES:
  0  the committed client is identical to what the current spec generates
  1  drift: files differ, are missing, or are present but not generated
  2  usage or configuration error (no spec found, invalid flag, bad config)
  3  generation failed (the spec could not be parsed or the generator errored)

- name: Client is up to date
  run: forge client check --from-spec ./openapi.json --output ./src/generated --hooks

forge client diff ./openapi.old.json ./openapi.json

EXIT CODES:
  0  no changes, or compatible changes only
  1  breaking changes present (API contract or cache identity)
  2  usage error: wrong arguments, a spec that could not be read or parsed,
     or a report that could not be rendered
  3  no breaking changes, but changes this differ declined to classify
     (UNKNOWN) -- a human has to look

BREAKING (CACHE) (15)
  DELETE /orders/{id}     invalidates tag "Order[]" removed
  DELETE /orders/{id}     entity typename changed Order -> PurchaseOrder, every persisted Order: key becomes unreachable
  GET /orders             provides tag "Order:{id}" removed
  GET /orders             provides tag "Order[]" removed
  GET /orders             entity typename changed Order -> PurchaseOrder, every persisted Order: key becomes unreachable
  GET /orders/{id}        provides tag "Order:{id}" removed
  GET /orders/{id}        entity typename changed Order -> PurchaseOrder, every persisted Order: key becomes unreachable
  PATCH /orders/{id}      invalidates tag "Order[]" removed
  PATCH /orders/{id}      provides tag "Order:{id}" removed
  PATCH /orders/{id}      entity typename changed Order -> PurchaseOrder, every persisted Order: key becomes unreachable
  POST /orders            invalidates tag "Order[]" removed
  POST /orders            provides tag "Order:{id}" removed
  POST /orders            entity typename changed Order -> PurchaseOrder, every persisted Order: key becomes unreachable
  entity Order            entity type Order is gone; a persisted store still holding Order: keys cannot reach them
  routing type OrderPage  normalization field edges changed

COMPATIBLE (9)
  DELETE /orders/{id}   invalidates tag "PurchaseOrder[]" added
  GET /orders           provides tag "PurchaseOrder:{id}" added
  GET /orders           provides tag "PurchaseOrder[]" added
  GET /orders/{id}      provides tag "PurchaseOrder:{id}" added
  PATCH /orders/{id}    invalidates tag "PurchaseOrder[]" added
  PATCH /orders/{id}    provides tag "PurchaseOrder:{id}" added
  POST /orders          invalidates tag "PurchaseOrder[]" added
  POST /orders          provides tag "PurchaseOrder:{id}" added
  entity PurchaseOrder  new entity type declared

Summary: 9 compatible, 0 breaking (API), 15 breaking (cache), 0 unknown
Error: 15 breaking change(s): 0 API, 15 cache

forge client watch --from-spec ./openapi.json --output ./src/generated --hooks

EXIT CODES:
  0  interrupted (SIGINT/SIGTERM) after a clean shutdown
  2  usage or configuration error (no spec found, invalid flag, nothing watchable)
  3  the watcher itself could not be started

forge client list --from-spec ./openapi.json --type rest

source:
  type: file
  path: ./openapi.json
defaults:
  language: typescript
  output: ./src/generated
  package: "@acme/orders-client"
  hooks: true
  auth: true
  streaming: true