treefmt/docs/quick-start.md

Quick start

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

1. Install the tool.
2. Install the needed formatters.
3. Run treefmt --init. This will generate the basic configuration file treefmt.toml containing the formatting rules.
4. Edit the configuration (see here how).
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.