# Where are the full 'cylc scan' docs?

**URL:** <https://cylc.discourse.group/t/where-are-the-full-cylc-scan-docs/801>\
**Category:** Cylc Support\
**Created:** [November 8, 2023, 11:42pm UTC](https://cylc.discourse.group/t/where-are-the-full-cylc-scan-docs/801 "2023-11-08T23:42:04Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![jonnyhtw](https://yyz2.discourse-cdn.com/free1/user_avatar/cylc.discourse.group/jonnyhtw/32/232_2.png) [@jonnyhtw](https://cylc.discourse.group/u/jonnyhtw)\
**Post date:** [November 8, 2023, 11:42pm UTC](https://cylc.discourse.group/t/where-are-the-full-cylc-scan-docs/801/1 "2023-11-08T23:42:04Z")

</div>

hi there,

in the `cylc scan` help it says…

```auto
  --states=STATES Choose which workflows to display by providing a list
                        of states or "all" to show everything. See the full
                        `cylc scan` help for a list of supported states.

```

where is this ‘full’ help? i looked [here](https://cylc.github.io/cylc-doc/latest/html/reference/api/scan.html) but can’t find anything relevant.

thanks

---

<div class="post-metadata">

**Author:** ![hilary.j.oliver](https://yyz2.discourse-cdn.com/free1/user_avatar/cylc.discourse.group/hilary.j.oliver/32/4_2.png) [@hilary.j.oliver](https://cylc.discourse.group/u/hilary.j.oliver)\
**Post date:** [November 9, 2023, 12:18am UTC](https://cylc.discourse.group/t/where-are-the-full-cylc-scan-docs/801/2 "2023-11-09T00:18:50Z")

</div>

Hmmm, that looks like a badly worded reference to the rest of `cylc scan --help`, as opposed to just the option help that you’ve quoted.

For workflow states, there are examples in the main help text above:

```auto
  # list workflows that are installed but stopped or not run yet
  $ cylc scan --state stopped

  # list all workflows (active or inactive)
  $ cylc scan --state=running,paused,stopped
  $ cylc scan --state=all # or using the shorthand

```

---

<div class="post-metadata">

**Author:** ![jonnyhtw](https://yyz2.discourse-cdn.com/free1/user_avatar/cylc.discourse.group/jonnyhtw/32/232_2.png) [@jonnyhtw](https://cylc.discourse.group/u/jonnyhtw)\
**Post date:** [November 9, 2023, 12:54am UTC](https://cylc.discourse.group/t/where-are-the-full-cylc-scan-docs/801/3 "2023-11-09T00:54:28Z")

</div>

ohhh got it, thanks @hilary.j.oliver 🙂

---

<div class="post-metadata">

**Author:** ![hilary.j.oliver](https://yyz2.discourse-cdn.com/free1/user_avatar/cylc.discourse.group/hilary.j.oliver/32/4_2.png) [@hilary.j.oliver](https://cylc.discourse.group/u/hilary.j.oliver)\
**Post date:** [November 9, 2023, 12:55am UTC](https://cylc.discourse.group/t/where-are-the-full-cylc-scan-docs/801/4 "2023-11-09T00:55:11Z")

</div>

Oh, and this bit of `cylc scan --help`!

![shot](https://global.discourse-cdn.com/free1/uploads/cylc1/original/1X/9ab17c2c9d9e2a23a43dd012000fc5d0850e304b.png)