CLI

The synodes command-line tool provides access to Synodes’s core features including managing Snapshots and the lifecycle of Synodes Sandboxes. View the installation instructions by clicking here.

This reference lists all commands supported by the synodes command-line tool complete with a description of their behaviour, and any supported flags. You can access this documentation on a per-command basis by appending the --help/-h flag when invoking synodes.

synodes

Synodes CLI

synodes [flags]

Flags

Long	Short	Description
`--help`		help for synodes
`--version`	`-v`	Display the version of Synodes

synodes autocomplete

Adds a completion script for your shell environment

synodes autocomplete [bash|zsh|fish|powershell] [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes docs

Opens the Synodes documentation in your default browser.

synodes docs [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes login [flags]

Flags

Long	Short	Description
`--api-key`		API key to use for authentication
`--help`		help for synodes

synodes logout

Logout from Synodes

synodes logout [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes mcp

Manage Synodes MCP Server

synodes mcp [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes mcp config

Outputs JSON configuration for Synodes MCP Server

synodes mcp config [AGENT_NAME] [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes mcp init

Initialize Synodes MCP Server with an agent (currently supported: claude, windsurf, cursor)

synodes mcp init [AGENT_NAME] [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes mcp start

Start Synodes MCP Server

synodes mcp start [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes organization

Manage Synodes organizations

synodes organization [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes organization create

Create a new organization and set it as active

synodes organization create [ORGANIZATION_NAME] [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes organization delete

Delete an organization

synodes organization delete [ORGANIZATION] [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes organization list

List all organizations

synodes organization list [flags]

Flags

Long	Short	Description
`--format`	`-f`	Output format. Must be one of (yaml, json)
`--help`		help for synodes

synodes organization use

Set active organization

synodes organization use [ORGANIZATION] [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes sandbox

Manage Synodes sandboxes

synodes sandbox [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes sandbox create

Create a new sandbox

synodes sandbox create [flags]

Flags

Long	Short	Description
`--auto-archive`		Auto-archive interval in minutes (0 means the maximum interval will be used)
`--auto-stop`		Auto-stop interval in minutes (0 means disabled)
`--class`		Sandbox class type (small, medium, large)
`--context`	`-c`	Files or directories to include in the build context (can be specified multiple times)
`--cpu`		CPU cores allocated to the sandbox
`--disk`		Disk space allocated to the sandbox in GB
`--dockerfile`	`-f`	Path to Dockerfile for Sandbox snapshot
`--env`	`-e`	Environment variables (format: KEY=VALUE)
`--gpu`		GPU units allocated to the sandbox
`--label`	`-l`	Labels (format: KEY=VALUE)
`--memory`		Memory allocated to the sandbox in MB
`--public`		Make sandbox publicly accessible
`--snapshot`		Snapshot to use for the sandbox
`--target`		Target region (eu, us)
`--user`		User associated with the sandbox
`--volume`	`-v`	Volumes to mount (format: VOLUME_NAME:MOUNT_PATH )
`--help`		help for synodes

synodes sandbox delete

Delete a sandbox

synodes sandbox delete [SANDBOX_ID] [flags]

Flags

Long	Short	Description
`--all`	`-a`	Delete all sandboxes
`--force`	`-f`	Force delete
`--help`		help for synodes

synodes sandbox info

Get sandbox info

synodes sandbox info [SANDBOX_ID] [flags]

Flags

Long	Short	Description
`--format`	`-f`	Output format. Must be one of (yaml, json)
`--verbose`	`-v`	Include verbose output
`--help`		help for synodes

synodes sandbox list

List sandboxes

synodes sandbox list [flags]

Flags

Long	Short	Description
`--format`	`-f`	Output format. Must be one of (yaml, json)
`--limit`	`-l`	Maximum number of items per page
`--page`	`-p`	Page number for pagination (starting from 1)
`--verbose`	`-v`	Include verbose output
`--help`		help for synodes

synodes sandbox start

Start a sandbox

synodes sandbox start [SANDBOX_ID] [flags]

Flags

Long	Short	Description
`--all`	`-a`	Start all sandboxes
`--help`		help for synodes

synodes sandbox stop

Stop a sandbox

synodes sandbox stop [SANDBOX_ID] [flags]

Flags

Long	Short	Description
`--all`	`-a`	Stop all sandboxes
`--help`		help for synodes

synodes snapshot

Manage Synodes snapshots

synodes snapshot [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes snapshot create

Create a snapshot

synodes snapshot create [SNAPSHOT] [flags]

Flags

Long	Short	Description
`--context`	`-c`	Files or directories to include in the build context (can be specified multiple times)
`--cpu`		CPU cores that will be allocated to the underlying sandboxes (default: 1)
`--disk`		Disk space that will be allocated to the underlying sandboxes in GB (default: 3)
`--dockerfile`	`-f`	Path to Dockerfile to build
`--entrypoint`	`-e`	The entrypoint command for the snapshot
`--image`	`-i`	The image name for the snapshot
`--memory`		Memory that will be allocated to the underlying sandboxes in GB (default: 1)
`--help`		help for synodes

synodes snapshot delete

Delete a snapshot

synodes snapshot delete [SNAPSHOT_ID] [flags]

Flags

Long	Short	Description
`--all`	`-a`	Delete all snapshots
`--help`		help for synodes

synodes snapshot list

List all snapshots

synodes snapshot list [flags]

Flags

Long	Short	Description
`--format`	`-f`	Output format. Must be one of (yaml, json)
`--limit`	`-l`	Maximum number of items per page
`--page`	`-p`	Page number for pagination (starting from 1)
`--help`		help for synodes

synodes snapshot push

Push local snapshot

synodes snapshot push [SNAPSHOT] [flags]

Flags

Long	Short	Description
`--cpu`		CPU cores that will be allocated to the underlying sandboxes (default: 1)
`--disk`		Disk space that will be allocated to the underlying sandboxes in GB (default: 3)
`--entrypoint`	`-e`	The entrypoint command for the image
`--memory`		Memory that will be allocated to the underlying sandboxes in GB (default: 1)
`--name`	`-n`	Specify the Snapshot name
`--help`		help for synodes

synodes version

Print the version number

synodes version [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes volume

Manage Synodes volumes

synodes volume [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes volume create

Create a volume

synodes volume create [NAME] [flags]

Flags

Long	Short	Description
`--size`	`-s`	Size of the volume in GB
`--help`		help for synodes

synodes volume delete

Delete a volume

synodes volume delete [VOLUME_ID] [flags]

Flags

Long	Short	Description
`--help`		help for synodes

synodes volume get

Get volume details

synodes volume get [VOLUME_ID] [flags]

Flags

Long	Short	Description
`--format`	`-f`	Output format. Must be one of (yaml, json)
`--help`		help for synodes

synodes volume list

List all volumes

synodes volume list [flags]

Flags

Long	Short	Description
`--format`	`-f`	Output format. Must be one of (yaml, json)
`--help`		help for synodes