Quantum CLI Reference

New: quantum-cli v3, our PaaS: Runway 🚀

quantum-cli #

A CLI tool for Planetary Quantum

Usage #

quantum-cli [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]

Global Options #

  • –api-key: Quantum API key (starts with ptr_) [$QUANTUM_API_KEY]
  • –log-format: Control log format (text, json) (default ““text””) [$LOG_FORMAT]
  • –log-output: Control the log output (stdout, stderr, off) (default ““stdout””) [$LOG_OUTPUT]
  • –log-debug-level: [$LOG_DEBUG_LEVEL, $DEBUG]
  • –help, -h: show help (default “false”)
  • –version, -v: print the version (default “false”)

Files #

  • ~/.config/quantum/env: optional file to set default env vars, e.g.:

      QUANTUM_API_KEY=ptr_your-key-here

  • */home/quantum/.cache/quantum/endpoints.json: endpoints cache

  • */home/quantum/.cache/quantum/version.json: version cache

Commands #

endpoints #

Look up endpoints

Aliases: endpoint, e, ep

endpoints list, ls #

List endpoints

  • –no-cache: use this flag to clear the cache (default “false”)
  • –output, -o: Output format: pretty, json (default ““pretty””)
  • –help, -h: show help (default “false”)

endpoints help, h #

Shows a list of commands or help for one command

stacks #

Commands about stacks

Aliases: stack, s

stacks deploy, create, update #

Deploy a stack (creates if new, updates if existing)

  • –endpoint: The endpoint/cluster to use [$QUANTUM_ENDPOINT, $PORTAINER_ENDPOINT]
  • –stack: The name of the stack [$QUANTUM_STACK]
  • –file, -f: Path to the Compose file (default: auto-detect one of docker-compose.yml, docker-compose.yaml, compose.yml, compose.yaml, stack.yml, stack.yaml in the current directory
  • –help, -h: show help (default “false”)

stacks list, ls #

List stacks

  • –endpoint: The endpoint/cluster to use [$QUANTUM_ENDPOINT, $PORTAINER_ENDPOINT]
  • –output, -o: Output format: pretty, json (default ““pretty””)
  • –help, -h: show help (default “false”)

stacks remove, rm #

Remove a stack

  • –endpoint: The endpoint/cluster to use [$QUANTUM_ENDPOINT, $PORTAINER_ENDPOINT]
  • –stack: The name of the stack [$QUANTUM_STACK]
  • –force: Don’t ask for confirmation (default “false”)
  • –help, -h: show help (default “false”)

stacks help, h #

Shows a list of commands or help for one command

exec #

Open a shell on a container, or run other commands

Aliases: shell, ssh

exec help, h #

Shows a list of commands or help for one command

show #

List tasks of an endpoint or stack or service

Aliases: ps

show help, h #

Shows a list of commands or help for one command

auth #

Authentication management

auth status #

Show authentication status

  • –output, -o: Output format: pretty, json (default ““pretty””)
  • –help, -h: show help (default “false”)

auth keys, ls #

List API keys from the server

  • –output, -o: Output format: pretty, json (default ““pretty””)
  • –help, -h: show help (default “false”)

auth rotate #

Rotate API key (replace cached key with new one)

  • –help, -h: show help (default “false”)

auth logout #

Clear cached credentials

  • –help, -h: show help (default “false”)

auth help, h #

Shows a list of commands or help for one command

mcp #

Model Context Protocol integration

mcp serve #

Start MCP server (stdio transport)

  • –enable-danger: Enable write/destructive tools (deploy, remove, exec, etc.) (default “false”)
  • –help, -h: show help (default “false”)

mcp help, h #

Shows a list of commands or help for one command

selfupdate #

Update quantum-cli to the latest version

Aliases: self-update

selfupdate help, h #

Shows a list of commands or help for one command

migration #

Migrate a stack including volumes + configs from one endpoint to another

Aliases: migrate

migration help, h #

Shows a list of commands or help for one command