openschema CLI · v0.1.0
Install the OpenSchema CLI
Add schemas from the registry, generate types for every target, and gate breaking changes in CI — from one cross-platform binary.
$
npm install -g openschema Package managers
Pick whichever fits your toolchain.
npm
$
npm install -g openschema Bun
$
bun add -g openschema Homebrew
$
brew install neoworks-io/tap/openschema Install script
$
curl -fsSL https://openschema.neoworks.dev/install.sh | sh Prebuilt binaries
Standalone executables — no Node or Bun runtime required. Vendor them straight into a CI image.
All releases are published on GitHub.
First commands
The essentials — see the full CLI reference for every flag.
parse Validate syntax and print a summary.
$
openschema parse order.schema diff Show every change between two schema versions.
$
openschema diff v1.schema v2.schema check Assert compatibility under a mode — built for CI.
$
openschema check published.schema proposed.schema gen Generate code for a target (sql, ts, go, graphql, …).
$
openschema gen order.schema --target ts