gws schema
Emit the live JSON schema for gws.json.
The schema is sourced from gws/src/schemas/gws-json.schema.ts — the same file gws config validate uses internally, so there is zero drift between what gws schema describes and what the API accepts.
Mostly used by:
- The
/gws-setupskill (first step of its loop) to learn the schema before generatinggws.json. - IDE / editor tooling that wants a JSON Schema for autocomplete and inline validation.
Usage
gws schema [--json]
| Flag | Description |
|---|---|
--json | Emit the raw JSON Schema to stdout (machine-readable). |
| (default) | Emit a human-readable summary listing required fields and top-level properties. |
Auth: not required. No I/O, no API call.
Examples
Human-readable summary:
$ gws schema
gws.json — GWS Configuration
Emit machine-readable JSON Schema with: gws schema --json
Required top-level fields: name, services
…
Pipe into a file for IDE autocomplete:
gws schema --json > schema.json
Then point your editor at schema.json (most editors recognize $schema references in gws.json, or you can wire it up via VS Code json.schemas settings).
Pipe into a JSON Schema validator:
gws schema --json | jq '.required'
See also
gws config validate— uses this exact schema offline- Zero-Config Setup with AI — where
/gws-setupcalls this