Skip to content
Synapse Synapse Docs

CLI Reference

Installation

Section titled “Installation”

The CLI is included with the Python SDK:

Terminal window
pip install synapserun
synapse --help

Sandbox Commands

Section titled “Sandbox Commands”
CommandDescription
synapse sandbox createCreate a new sandbox
synapse sandbox listList running sandboxes
synapse sandbox info <id>Get sandbox details
synapse sandbox run <id> <code>Execute code in a sandbox
synapse sandbox exec <id> <cmd>Run a shell command
synapse sandbox kill <id>Kill a sandbox
synapse sandbox pause <id>Pause a sandbox
synapse sandbox resume <id>Resume a paused sandbox
synapse sandbox snapshot <id>Create a filesystem snapshot

Template Commands

Section titled “Template Commands”
CommandDescription
synapse template listList available templates
synapse template info <name>Get template details
synapse template createRegister a new template
synapse template build <dockerfile>Build from Dockerfile
synapse template delete <name>Delete a template

Examples

Section titled “Examples”
Terminal window
# Create and use a sandbox
synapse sandbox create --template python3 --persistent
# Returns: cell_id: abc123...


synapse sandbox run abc123 "print('Hello!')"
# stdout: Hello!


synapse sandbox list
# ID         STATUS   TEMPLATE   CREATED
# abc123...  running  python3    2026-05-14T12:00:00Z


synapse sandbox kill abc123

Configuration

Section titled “Configuration”
Terminal window
# Set API key
export SYNAPSE_API_KEY="cell_sk_live_..."


# Set gateway URL (for self-hosted)
export SYNAPSE_API_URL="http://localhost:8001"