Browse documentation

More CLI commands

Sign in, import a schema, run the local harness, diagnose, register an external MCP server, and apply catalog overlays.

Beyond init, the CLI has a handful of commands for authentication, alternative discovery, local development, and maintenance.

Sign in with a token generated in the dashboard. The CLI stores it in ~/.syncanix/credentials (readable only by you). Sign out to remove it.

npx syncanix login
npx syncanix logout

Available at launch — this package is not on its public registry yet, so the command above will work the day Syncanix opens.

Import a schema

Already have an OpenAPI or GraphQL schema? Build a catalog from it directly, with no code scan. Pass --offline to skip uploading, or --env to target an environment.

npx syncanix import --openapi ./openapi.json
npx syncanix import --graphql ./schema.graphql

Available at launch — this package is not on its public registry yet, so the command above will work the day Syncanix opens.

Local dev harness

Run a local page that embeds the widget against a development backend and live-reloads as your catalog changes. Flags let you set the port, backend origin, widget source, publishable key, and catalog path.

npx syncanix dev --port 4321

Available at launch — this package is not on its public registry yet, so the command above will work the day Syncanix opens.

Diagnose your setup

Check your environment for common problems — Node version, a detected framework, a valid config, and a resolvable API key. It exits non-zero if anything is wrong.

npx syncanix doctor

Available at launch — this package is not on its public registry yet, so the command above will work the day Syncanix opens.

Register an external MCP server

If your workspace already runs its own MCP server, register it so Syncanix can forward tool calls to it. You’ll need to be signed in; the credential is stored securely and never echoed back.

npx syncanix byomcp register --server-url https://mcp.example.com

Available at launch — this package is not on its public registry yet, so the command above will work the day Syncanix opens.

Catalog-as-code overlays

Manage a committed syncanix.yaml overlay: init scaffolds one, validate checks it, and apply merges it onto a discovered catalog.

npx syncanix yaml init
npx syncanix yaml validate
npx syncanix yaml apply --catalog ./.syncanix/catalog.json

Available at launch — this package is not on its public registry yet, so the command above will work the day Syncanix opens.

Version

Print the CLI, Node, and build versions — handy when reporting an issue.

npx syncanix version

Available at launch — this package is not on its public registry yet, so the command above will work the day Syncanix opens.

Next steps

syncanix initThe main discovery command.Identity & authenticationHow MCP clients sign in.