​
SynapseX CLI

SynapseX currently ships two command-line surfaces in this repository.
CLIPackageUse it for
Developer CLIsynapsex-cliCloud agents, API keys, jobs, MCP catalog, deploy commands
VM/Ops CLIsynapsex-cliVM agents, tasks, incidents, secrets, operational health checks
The public cloud CLI is the Node.js developer CLI. The Python sx CLI is maintained for VM operations and self-hosted deployments.

​
Install

​
Quick install (standalone binary)

curl -fsSL https://synapsex.ai/install | bash
synapsex --version
Downloads a standalone binary for your platform (macOS, Linux, Windows). No Node.js or Python required.

​
Developer CLI

npm install -g synapsex-cli
synapsex --version
From source: 
cd apps/agents-synapsex/shared/cli
npm install
npm run build
node bin/synapsex.js --help

​
VM/Ops CLI

pip install synapsex-cli
sx --version
From source: 
cd agents/vm-cli
pip install -e .
sx --help

​
Authenticate

Developer CLI: 
synapsex login --api-key sk_...
synapsex login --email user@example.com
synapsex logout
VM/Ops CLI: 
sx auth login --email user@example.com --url https://api.synapsex.ai
sx auth whoami
sx auth logout

​
Common Workflows

Create and invoke a cloud agent with the developer CLI: 
synapsex agent create my-agent --model gpt-4o --tools web-search file-read
synapsex agent list
synapsex agent invoke my-agent "Summarize the latest deployment logs"
synapsex run my-agent --input "Check service health" --stream
Submit and inspect jobs: 
synapsex jobs submit "Analyze failing tests" --agent my-agent --type code
synapsex jobs list --status running
synapsex jobs status <job-id>
synapsex jobs cancel <job-id>
Operate VM agents with the Python CLI: 
sx status
sx agents list --status running
sx tasks create --agent <agent-id> --input "Run diagnostics"
sx tasks stream <task-id>
sx incidents list
sx scan --vm <vm-id>

​
Environment Variables

Developer CLI: 
export SYNAPSEX_API_BASE=https://api.synapsex.ai/v1
export SYNAPSEX_AUTH_URL=https://api.synapsex.ai
VM/Ops CLI: 
sx config set base_url https://api.synapsex.ai

​
Current Limitations

The in-repository CLIs do not currently provide synapsex mcp serve, synapsex models list, or synapsex agent run --task. Use the commands above or the REST API directly.