octopus runbook list

List runbooks in Octopus Deploy

Usage:
  octopus runbook list [flags]

Aliases:
  list, ls

Flags:
  -q, --filter string    filter runbooks to match only ones with a name containing the given string
      --git-ref string   Git reference to list runbooks for e.g. refs/heads/main. Only relevant for config-as-code projects where runbooks are stored in Git.
      --limit int32      limit the maximum number of results that will be returned
  -p, --project string   Name or ID of the project to list runbooks for


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

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 SomeProject
$ octopus runbook list --project SomeProject --limit 50 --filter SomeKeyword
$ octopus runbook ls -p SomeProject -n 30 -q SomeKeyword

Learn more

Help us continuously improve

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

Send feedback

Page updated on Wednesday, February 19, 2025

Edit on GitHub