@schema-gen/cli
v0.2.1
Published
CLI for schema-gen - OpenAPI to TypeScript/React Query/Vue Query code generation
Readme
@schema-gen/cli
CLI for schema-gen — OpenAPI to TypeScript / React Query / Vue Query code generation.
Provides the schema-gen binary. Reads a schema-gen.config.{ts,js,yaml,json} from your project, parses your OpenAPI spec via the Rust-powered core, and writes generated code to the configured output directory.
Install
Project-local (recommended — pin the version with the rest of your toolchain):
pnpm add -D @schema-gen/cli
# or
npm install --save-dev @schema-gen/cli
# or
yarn add -D @schema-gen/cliGlobal:
pnpm add -g @schema-gen/cliOr run without installing:
npx @schema-gen/cli generateQuick start
schema-gen init # create a starter schema-gen.config.ts
schema-gen generate # generate code using the config
schema-gen generate -w # watch modeCommands
| Command | Description |
|---|---|
| generate [spec] (alias gen) | Generate code from an OpenAPI spec. Flags: -c, --config <path>, -i, --input <path>, -o, --output <dir>, -w, --watch |
| validate <spec> | Validate that a spec parses cleanly |
| ast <spec> | Print the parsed AST. Flags: -f, --format <json\|yaml>, -o, --output <path> |
| init | Scaffold a schema-gen.config.ts. Flag: -f, --force to overwrite |
| --version, --help | Standard |
A positional [spec] arg or -i/--input overrides input.path from the config; -o/--output overrides output.dir.
Example
# schema-gen.config.yaml
input:
path: ./openapi.yaml
output:
dir: ./src/api
clean: true
plugins:
- typescript-types
- typescript-enums
- request-pathsschema-gen generateDocumentation
- Repository: https://github.com/gkweb/schema-gen
- CLI reference: docs/guide/cli.md
- Configuration: docs/guide/configuration.md
- Changelog:
CHANGELOG.md
License
MIT © gkweb
