Octopus Deploy Documentation

octopus runbook list

Last updated

List runbooks in Octopus Deploy

  octopus runbook list [flags]

  list, ls

  -q, --filter string    filter runbooks to match only ones with a name containing the given string
      --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


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

Need support? We're here to help.