skip to main content
Browse documentation

The Syncanix CLI

Discover your API and manage your catalog from the command line — no install required.

The syncanix CLI is how you discover your API and manage your catalog from the command line. You don’t need to install anything — run it with npx.

Install

Run the CLI straight from npm with npx — no global install required:

npx syncanix@latest init

Node.js 20 or newer is required.

Commands

init
Scan your codebase, build the capability catalog, and upload it.
import
Build a catalog from an existing OpenAPI or GraphQL schema.
login / logout
Sign in with a CLI token, or sign out again.
dev
Run a local harness that embeds the widget against a dev backend.
doctor
Check your environment and configuration for common problems.
byomcp register
Register an external MCP server your workspace already runs.
yaml
Create, validate, and apply a catalog-as-code overlay.
version
Print the CLI, Node, and build versions.

Global options

-v, --version
Print the CLI version and exit.
--no-color
Disable coloured output.
--locale <code>
Set the output language: en, es, fr, de, ar, or he.

Next steps