octopus runbook

Manage runbooks in Octopus Deploy

Usage:
  octopus runbook [command]

Available Commands:
  delete Delete a runbook
  help Help about any command
  list List runbooks
  run Run runbooks in Octopus Deploy
  snapshot Manage runbook snapshots

Global Flags:
  -h, --help                   Show help for a command
      --no-prompt              Disable prompting in interactive mode
  -f, --output-format string   Specify the output format for a command ("json", "table", or "basic") (default "table")
  -s, --space string           Specify the space for operations


Use "octopus runbook [command] --help" for more information about a command.

Examples

Octopus Samples instance

Many of the examples we use, reference the samples instance of Octopus Deploy. If you’d like to explore the samples instance, you can log in as a guest.

octopus runbook list
octopus runbook run

Learn more

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Sunday, April 19, 2026