Messy API specs? Bring order from the command line — overlay, dereference, bundle, convert, and validate.
Note: Currently only the
overlaycommand is implemented. More commands are coming soon.
@speclynx/cli is part of the SpecLynx ecosystem, built on top of ApiDOM and ApiDOM Language Service.
npm install -g @speclynx/cliOr use directly with npx:
npx @speclynx/cli overlay apply overlay.json openapi.jsonspeclynx --help # list all commands
speclynx overlay --help # list overlay subcommands
speclynx overlay apply --help # show overlay apply optionsApply Overlay 1.x documents to API definitions.
Supported Overlay versions:
The target can be any JSON or YAML document.
speclynx overlay apply [options] <overlay> [target]
Arguments:
| Argument | Description |
|---|---|
<overlay> |
Path to the overlay document (JSON or YAML) |
[target] |
Path to the target document; if omitted, uses the overlay extends field |
Options:
| Option | Description |
|---|---|
--overlay <path> |
Additional overlay document to apply sequentially (repeatable) |
-o, --output <file> |
Write result to file instead of stdout |
-f, --format <format> |
Output format: json or yaml (auto-detected from target extension) |
--strict |
Fail if any action target matches zero nodes |
--verbose |
Print trace information about overlay application |
Apply an overlay to an OpenAPI document:
speclynx overlay apply overlay.json openapi.jsonApply an overlay that uses the extends field to reference the target:
speclynx overlay apply overlay.yamlWrite the result to a file:
speclynx overlay apply overlay.json openapi.json -o result.jsonForce YAML output regardless of target extension:
speclynx overlay apply overlay.json openapi.json -f yamlApply multiple overlays sequentially:
speclynx overlay apply first.json openapi.json --overlay second.json --overlay third.jsonUse strict mode to catch unmatched targets:
speclynx overlay apply overlay.json openapi.json --strictShow detailed trace of each action:
speclynx overlay apply overlay.json openapi.json --verboseOverlay: overlay.json -> openapi.json
[ok] update $.info (1 matches)
Overlay was successfully applied
{ ... }
SpecLynx CLI is licensed under Apache 2.0 license. SpecLynx CLI comes with an explicit NOTICE file containing additional legal notices and information.