Skip to main content

octopus

octopus​

Octopus's command-line interface

Synopsis​

octopus talks to an Octopus kernel over gRPC.

Commands follow a "resource verb" grammar (for example "octopus account list"). Connection settings live in named profiles in ~/.octopus/config.yaml; see "octopus config". Results are printed for humans by default; use --output json for scripts.

Examples​

octopus config init
octopus --tenant acme-bank account list
octopus --tenant acme-bank account list --output json

Options​

  -c, --correlation string       Correlation ID for request tracing (UUID, auto-generated if omitted)
  -g, --global                   Shorthand for --tenant global
  -h, --help                     help for octopus
  -i, --idempotency-key string   Idempotency key for exactly-once execution (UUID, auto-generated per operation if omitted)
  -o, --output string            Output format: human, json (default "human")
  -p, --profile string           Override active config profile for this command.
  -t, --tenant string            Tenant code. Overrides default_tenant from config.
  -v, --verbose                  Enable verbose output

SEE ALSO​