Skip to content
Treefmt
Readme: treefmt — one CLI to format your repo
About the project
Quickstart
Usage
Formatters
Contribution guidelines
Enabling nix flakes
More
Share
Explore

Quickstart

Installation
Configuration
To run treefmt in your project, please follow these steps:
⁠
Install the tool.
⁠
⁠
Install the needed formatters.
Run treefmt --init. This will generate the basic configuration file treefmt.toml containing the formatting rules.
Edit the configuration (see here how).
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.

Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.