The Syncanix CLI

You do not need the CLI to get started. The widget discovers your product from the pages themselves, and on its own that is a working catalog. The CLI is the deeper pass: it reads your source, so it can give the agent exact argument names and types that looking at a screen cannot reveal — and it manages your catalog from the command line. Nothing to install; 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.

console

Open the interactive console — the same thing a bare `syncanix` does at a terminal.

generate

Write the syncanix/ integration kit into your project, creating new files only.

integrate

Detect your frontend and install the widget for you, one approved file at a time.

status

Compare this checkout with what your workspace is actually serving.

import

Build a catalog from an existing OpenAPI or GraphQL schema.

login / logout

Sign in with your browser (or --key for CI), or sign out again.

whoami

Show who you're signed in as and which workspace.

workspace list / use

List your workspaces or set the default one.

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 colored output.

--locale <code>

Set the output language: en, es, fr, de, ar, or he.

Next steps