skip to main content
Browse documentation

The interactive console

Run syncanix with no arguments to open a full-screen console where you can see your catalog, compare it with your workspace, govern capabilities, mint keys and generate the integration kit.

Run the CLI with no arguments at a terminal and it opens a console instead of printing help. Everything the CLI can do that involves looking at something and then deciding โ€” reading the last scan, comparing it with what your workspace serves, turning a capability on, editing the text the agent reads โ€” lives here, without flags to remember.

npx syncanix

Signing in, or not

If you have already run syncanix login, the console opens straight into your workspace and acts with your own role. If not, it offers to sign you in through your browser first.

You can also continue without signing in. Everything that needs a workspace โ€” governance, keys, content, the comparison โ€” stays on the menu, marked locked with what would unlock it, so you can see what signing in gives you. What works locally still works: reading your last scan, and generating the integration kit, which asks for your publishable key instead.

What you can do

Read the last scan
Browse the capabilities the CLI found, with their risk class and whether they need authentication.
Compare with your workspace
See what this checkout has that your workspace does not yet serve, what has changed, and what your workspace still serves that the code no longer has.
Push your scan to the workspace
Upload the catalog your last scan produced, with the same consent prompts a terminal run shows.
Turn capabilities on and off
Govern what the agent may do, and clear the approval queue that governing creates.
Edit what the agent reads
Change a capability's name and description, with a preview of the composed text the model actually receives.
See and mint keys
List your workspace's API keys, and mint a publishable one for an embed.
Scan this repository
Run a fresh scan without leaving the console, with the same consent prompts a terminal run shows.
Generate the integration kit
Write the syncanix/ directory into this repository โ€” new files only, never an edit to yours.
Switch workspace
Pick which of your workspaces the next action applies to.

Nothing is easier here than it is anywhere else

The console is a different way to reach the same server, not a different set of rules. Every permission check, every consent prompt and every approval gate applies exactly as it does from a scripted command.

Turning it off

Set SYNCANIX_NO_TUI=1 and a bare invocation prints help again. Useful in a shell where the CLI is invoked without arguments by a wrapper you do not control.

SYNCANIX_NO_TUI=1 npx syncanix

Next steps