Skip to main content

👩‍💻 Command line interface

delete​

Delete a sandbox

Removes both the sandbox's Git branch and container. Active sandboxes require the --force flag to prevent accidental deletion.

Arguments:

  • NAME Name of the sandbox to delete

Options:

  • -f, --force <FORCE> Force deletion even if the sandbox is active
  • -h, --help Print help (see more with '--help')

docgen​

Generate reference documentation

Prints docs to stdout.

Options:

  • -h, --help Print help (see more with '--help')

help​

Print this message or the help of the given subcommand(s)

list​

List all sandboxes in the current repository

Shows all sandboxes with their current status (active, paused, missing, or error). Status information requires Docker to be available; otherwise statuses show as unknown.

Options:

  • -h, --help Print help (see more with '--help')

pause​

Pause one or more sandboxes

Pauses the container(s) associated with sandbox(es), preserving their state while freeing up system resources. Paused sandboxes can be resumed later.

Arguments:

  • [NAME] Sandbox name to pause

Options:

  • --all-envs <ALL_ENVS> Pause all sandboxes in this repository
  • --all-repos <ALL_REPOS> Pause all Litterbox containers system-wide
  • -h, --help Print help (see more with '--help')

resume​

Resume a paused sandbox

Resumes a previously paused sandbox, restoring its container to an active state.

Arguments:

  • NAME Name of the sandbox to resume

Options:

  • -h, --help Print help (see more with '--help')

shell​

Execute a shell command in a sandbox

Runs the specified command inside the sandbox's container and returns the output. The command is executed in the sandbox's working directory.

Arguments:

  • NAME Name of the sandbox to run the command in
  • COMMAND Command and arguments to execute

Options:

  • -h, --help Print help (see more with '--help')

stdio​

Run the MCP (Model Control Protocol) server over stdio

Starts the Litterbox MCP server, enabling communication with AI agents and tools that support the Model Control Protocol. The server uses standard input/output for communication.

Options:

  • -h, --help Print help (see more with '--help')