﻿# octopus runbook list

List runbooks in Octopus Deploy

```text
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

:::div{.success}
**Octopus Samples instance**

Many of the examples we use, reference the [samples instance](https://samples.octopus.app/app#/users/sign-in) of Octopus Deploy. If you'd like to explore the samples instance, you can log in as a guest.
:::

```bash
octopus runbook list SomeProject
octopus runbook list --project SomeProject --limit 50 --filter SomeKeyword
octopus runbook ls -p SomeProject -n 30 -q SomeKeyword

```

## Learn more

- [Octopus CLI](/docs/octopus-rest-api/cli)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
