Soxom CLI

The Soxom CLI lets you validate your config and preview your SDKs without pushing to your Config Repository. It’s the fastest feedback loop for iterating on openapi.yaml and soxom.yaml.

The CLI is a single static binary written in Rust. It runs locally for validation (no network), and shells out to the Soxom API for previews so the generators stay in lockstep with what your Config Repository builds will produce.

Installation

Homebrew (recommended)

brew install soxom/tap/soxom

This is the easiest path on macOS and Linux. Homebrew handles updates and keeps the binary on your PATH. macOS users especially should prefer Homebrew, because binaries installed this way are not quarantined by Gatekeeper.

Cargo (from source)

cargo install soxom-cli

Requires a recent Rust toolchain (1.80+).

Direct download

Grab a binary from the latest release. Pick the archive matching your OS and architecture, extract soxom, and move it somewhere on your PATH (e.g. /usr/local/bin on macOS / Linux).

Caution

macOS users: binaries downloaded directly from GitHub releases are quarantined by Gatekeeper and will refuse to launch the first time. Install via Homebrew (preferred), or remove the quarantine attribute manually:

xattr -d com.apple.quarantine ./soxom

Verify the install

soxom --version

What’s next

Authenticate the CLI Sign in once and reuse the token across projects.

Initialize a new project Scaffold openapi.yaml and soxom.yaml in seconds.

Validate your config Catch errors locally before pushing.

Preview a build Generate an SDK from your local files.

Command reference Every flag, exit code, and environment variable.