Skip to content

CLI reference — Forge Instances

Generated by bun run generate:cli-reference from spec/admin-api-openapi.json. Do not hand-edit — regenerate after refreshing the spec.

Every operation below is documented CLI-first (nayaone-admin api <operationId>) per PRD-407/DO-7. The REST /admin-api/* method+path is the fallback/alternative integration option.

4 operations in this area.

PRD-317/C — record a new forge_instance row

CLI (preferred):

Terminal window
nayaone-admin api createForgeInstance --body '{}'

REST fallback: POST /admin-api/forge-instances

PRD-317/C — read one forge_instance row

CLI (preferred):

Terminal window
nayaone-admin api getForgeInstance --param id=<id>

REST fallback: GET /admin-api/forge-instances/{id}

PRD-317/C — list every forge_instance row

CLI (preferred):

Terminal window
nayaone-admin api listForgeInstances

REST fallback: GET /admin-api/forge-instances

PRD-317/C — update status / metadata on a forge_instance row

CLI (preferred):

Terminal window
nayaone-admin api patchForgeInstance --param id=<id> --body '{}'

REST fallback: PATCH /admin-api/forge-instances/{id}