# `mix ash_state_machine.generate_flow_charts`
[🔗](https://github.com/ash-project/ash_state_machine/blob/v0.2.13/lib/mix/generate_flow_charts.ex#L5)

Generates a Mermaid Flow Chart for each `Ash.Resource` with the `AshStateMachine`
extension alongside the resource.

## Prerequisites

This mix task requires the Mermaid CLI to be installed on your system.

See https://github.com/mermaid-js/mermaid-cli

## Command line options

  * `--type` - generates a given type. Valid values are `"state_diagram"` and `"flow_chart"`. Defaults to `"state_diagram"`.
  * `--only` - only generates the given Flow file
  * `--format` - Can be set to one of either:
    * `plain` - Prints just the mermaid output as text. This is the default.
    * `md` - Prints the mermaid diagram in a markdown code block.
    * `svg` - Generates an SVG
    * `pdf` - Generates a PDF
    * `png` - Generates a PNG

# `run`

---

*Consult [api-reference.md](api-reference.md) for complete listing*
