SynapseX CLI overview
The SynapseX CLI puts an AI coding agent, a scriptable one-shot runner, a headless HTTP server and a free offline quantum simulator into one self-contained binary. By the end of this section you will have it installed, signed in to your SynapseX account, and running real work from your terminal — including two things that need no account and no network at all.
What is the command called?
The command you type is synapsex-code.
Two naming details will otherwise confuse you:
- The CLI’s own help output labels every line
synapsexCode. That is the program’s internal script name, not a second command. Do not type it. - There is no
sxcommand. Anything that tells you to run./sxis a local development wrapper, not the shipped product.
What can the CLI do?
| Job | Start here | Needs an account? |
|---|---|---|
| Code with an AI agent, interactively or as one scriptable command | Terminal agent | Yes |
| Simulate a quantum circuit locally | Quantum simulator | No |
| Run a local Python, Node, shell, Ruby or Perl file through the lab runner | Local runs | No |
| Serve the agent over HTTP, or open its web interface | Headless server | Yes, for AI turns |
| Give the agent your own tools through MCP servers | MCP servers | Yes, for AI turns |
| Audit sessions, cost and token usage; move work between machines | Sessions and usage | No |
Prove the install in ten seconds, with no account
Two capabilities are entirely local: the OpenQASM statevector simulator and the
lab file runner. Both are $0, off-ledger and work offline, so they are the
fastest way to confirm the binary is installed and working before you sign in to
anything.
# A real quantum circuit, sampled locally, with no credentials and no network.
cat > bell.qasm <<'EOF'
OPENQASM 2.0;
include "qelib1.inc";
qreg q[2];
creg c[2];
h q[0];
cx q[0],q[1];
measure q -> c;
EOF
synapsex-code lab run bell.qasm --sim --shots 100 --seed 7mode=sim (local, off-ledger, $0) file=bell.qasm
qubits=2 shots=100
counts:
11 57 (57.0%)
00 43 (43.0%)If you see those counts, the CLI works. Full details, including the exact gate subset the simulator supports, are on Run a quantum circuit offline.
Which models can the CLI use?
The CLI’s model list is SynapseX-only. synapsex-code providers login offers
exactly two options — SynapseX (AI models) and SynapseX Compute (Lab
compute) — and passing any third-party provider id, such as
--provider anthropic or --provider openai, fails with Unknown provider.
Get the exact model ids you can pass to -m by running synapsex-code models
once you are signed in; they are printed with the synapsex/ prefix. See
Sign the CLI in to your SynapseX account.
Where does the CLI keep my credentials and data?
Nothing here is a secret you type. Both credentials are minted by browser approval and written to disk by the CLI itself.
| What | Where |
|---|---|
Credentials (synapsex and synapsex-compute) | ~/.local/share/synapsexCode/auth.json, mode 0600 |
| Sessions and usage statistics | ~/.local/share/synapsexCode/synapsexCode.db (SQLite) |
| Global configuration | ~/.config/synapsexCode/ |
| Per-project configuration | synapsexCode.json / synapsexCode.jsonc / .synapsexCode/ |
| Active Lab session per project | ~/.local/state/synapsexCode/lab-sessions.json (session ids only, never tokens) |
Run synapsex-code debug paths to print the resolved locations on your machine.
The full list of paths, config files and environment variables is in
CLI configuration.
Where is the complete command list?
This section covers the tasks. For every command, subcommand and flag, see CLI commands.