Validate, overlay, and reshape your API specs with one consistent toolchain, from the command line.
OpenAPI, AsyncAPI, Arazzo, and Overlay, in JSON or YAML, through one consistent toolchain.
Local-first: no accounts, no telemetry, works offline.
Documentation · npm · Discussions · Issues
Validate any spec. Nothing to install, no account:
npx @speclynx/cli validate openapi.yaml
npx @speclynx/cli validate asyncapi.yaml
npx @speclynx/cli validate arazzo.yaml
npx @speclynx/cli validate overlay.yaml
Apply or generate overlays:
npx @speclynx/cli overlay apply add-contact.yaml museum.yaml
npx @speclynx/cli overlay diff openapi-v1.yaml openapi-v2.yaml
Prefer a global install?
npm install -g @speclynx/cli
speclynx --help| Command | What it does |
|---|---|
validate |
Validate and lint OpenAPI 2.0/3.0/3.1, AsyncAPI 2.x, Arazzo 1.x, and Overlay 1.x documents, from a file or a URL. |
overlay apply |
Apply one or more Overlay 1.0/1.1/1.2 documents to any JSON or YAML document. |
overlay diff |
Generate an Overlay document that turns one API document into another. |
Built for CI: exit codes gate on a severity you choose (--fail-severity), and diagnostics are available as JSON (--format json).
dereference, bundle, and convert are on the roadmap.
Every option is documented in the CLI reference and in speclynx <command> --help.
@speclynx/cli is one piece of SpecLynx, an open source toolchain for API specs. The same engine powers every tool.
| Tool | What it does | Type |
|---|---|---|
| Editor | Write and validate specs in the browser, nothing to install. | Browser editor |
| OpenAPI Toolkit | Validation, completion, and preview while you author specs. | VS Code extension |
| Language Service | LSP intelligence for API specs; the validation layer behind speclynx validate. |
Integration library |
| ApiDOM | Parse, dereference, and bundle any API spec through one lossless semantic structure. | Core library |
| UseArazzo | Validate, run, and trace Arazzo API workflows. Built on SpecLynx. | Workflow toolkit |
Ask in GitHub Discussions, or open an issue if something is broken. Contributions are welcome, see CONTRIBUTING.md.
SpecLynx CLI is licensed under Apache 2.0 license. SpecLynx CLI comes with an explicit NOTICE file containing additional legal notices and information.