---
outline: none
---

# Quick start

To run `treefmt` in your project, please follow these steps:

1. [Install] `treefmt`.
2. Install any formatters you wish to use with `treefmt`.
3. Run `treefmt --init` to generate a basic configuration file `treefmt.toml`.
4. Edit the configuration, adding formatters as desired. See [here] for more info on how to configure a formatter.
5. Run `treefmt` with the needed flags and options. You can check the supported options by executing `treefmt --help`.

In the following sections we will guide you through installing and configuring `treefmt` in detail.

[install]: installation.md
[here]: formatter-spec.md