Command Reference

Developer CLI (synapsex)

The developer CLI is the Node.js package synapsex-cli.

Global

synapsex --version
synapsex --help

Authentication

synapsex login --api-key sk_...
synapsex login --email user@example.com
synapsex logout
API keys require an email/password login because key management uses the session access token:
synapsex keys --list
synapsex keys --create "CI deploy key"
synapsex keys --delete <key-id>
synapsex keys --revoke <key-id>

Agents

synapsex agent create <name> --model gpt-4o --tools web-search file-read --description "Ops helper"
synapsex agent list
synapsex agent list --quiet
synapsex agent status <agent-id>
synapsex agent logs <agent-id> --lines 100
synapsex agent invoke <agent-id> "Analyze this incident" --stream
synapsex agent delete <agent-id> --force

Run

synapsex run <agent-id> --input "Check production readiness"
synapsex run <agent-id> --input "Tail logs and summarize errors" --stream

Jobs

synapsex jobs submit "Analyze failing tests" --agent <agent-id> --type code --priority 5
synapsex jobs list
synapsex jobs list --agent <agent-id> --status running
synapsex jobs status <job-id>
synapsex jobs cancel <job-id>

MCP Catalog

synapsex mcp list
synapsex mcp list --category filesystem
synapsex mcp info file-read
synapsex mcp add https://registry.example.com --name partner-tools

Intelligent MCP Routing

synapsex mcp route "run QAOA for this graph"
synapsex mcp plan "restart nginx if logs show gateway errors" --tenant tenant-123
synapsex mcp ask "get CPU metrics" --preferred synapsex-ops-mcp --vm vm-123 --approve
synapsex mcp ask "run QAOA" --preferred qcos-mcp --tool optimize_qaoa --tool-input '{"p":2,"shots":1024}' --approve
synapsex mcp plan "compare VQE and QAOA" --json

Config

synapsex config set apiBase https://api.synapsex.ai/v1
synapsex config get apiBase
synapsex config list
synapsex config clear

Deploy

synapsex deploy local <agent-id> --port 8080
synapsex deploy cloud <agent-id>

VM/Ops CLI (sx)

The Python CLI is the synapsex-cli package. It exposes the sx and synapsex binaries.

Auth

sx auth login --email user@example.com --url https://api.synapsex.ai
sx auth whoami
sx auth logout

Platform Health

sx status
sx scan --vm <vm-id>
sx scan --agent <agent-id>

Agents

sx agents list --limit 50
sx agents list --status running
sx agents get <agent-id>
sx agents create --name ops-agent --vm-id <vm-id> --model claude-3-5-sonnet-20241022 --provider anthropic
sx agents stop <agent-id>
sx agents restart <agent-id>
sx agents dispatch <agent-id> "Run service diagnostics"
sx agents dispatch <agent-id> "Run service diagnostics" --no-stream

Tasks

sx tasks list --limit 20
sx tasks list --agent <agent-id> --status running
sx tasks get <task-id>
sx tasks create --agent <agent-id> --input "Inspect disk usage"
sx tasks create --agent <agent-id> --input "Inspect disk usage" --no-stream
sx tasks stream <task-id>

Configuration

sx config set base_url https://api.synapsex.ai
sx config get base_url
sx config list
sx config unset base_url

Other VM/Ops Groups

sx vms list
sx vms get <vm-id>
sx vms status <vm-id>
sx incidents list
sx incidents get <incident-id>
sx incidents analyze <incident-id>
sx secrets list
sx secrets rotate <secret-id>

Not Implemented In The Current CLIs

These commands appeared in older docs but are not implemented in the current in-repository CLIs:
  • synapsex mcp serve
  • synapsex models list
  • synapsex agent run --task ...
  • blackbox ...