Files
docker-docs/data/cli/sandbox/docker_sandbox_ls.yaml
2026-02-24 08:01:08 +01:00

116 lines
2.7 KiB
YAML
Generated

command: docker sandbox ls
aliases: docker sandbox ls, docker sandbox list
short: List VMs
long: List all VMs managed by sandboxd with their sandboxes
usage: docker sandbox ls [OPTIONS]
pname: docker sandbox
plink: docker_sandbox.yaml
options:
- option: json
value_type: bool
default_value: "false"
description: Output in JSON format
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only display VM names
details_url: '#quiet'
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: socket
value_type: string
description: |
Connect to daemon at specific socket path (for development/debugging)
deprecated: false
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### List all VMs
```console
$ docker sandbox ls
VM ID NAME STATUS WORKSPACE SOCKET PATH SANDBOXES AGENTS
abc123def claude-vm running /home/user/my-project /Users/.../docker-1764682554072.sock 2 claude
def456ghi gemini-vm stopped /home/user/ml-projects
```
### Show only VM names (--quiet) {#quiet}
```text
--quiet
```
Output only VM names:
```console
$ docker sandbox ls --quiet
claude-vm
gemini-vm
```
### JSON output (--json)
```text
--json
```
Output detailed VM information in JSON format:
```console
$ docker sandbox ls --json
{
"vms": [
{
"name": "claude-vm",
"agent": "claude",
"status": "running",
"socket_path": "/Users/user/.docker/sandboxes/vm/claude-vm/docker-1234567890.sock",
"sandbox_count": 2,
"workspaces": [
"/home/user/my-project",
"/home/user/another-project"
]
},
{
"name": "gemini-vm",
"agent": "gemini",
"status": "stopped",
"sandbox_count": 0
}
]
}
```
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false