From e3fabb17e8bc97d31672e7b5b658fe08a2e32ba1 Mon Sep 17 00:00:00 2001 From: Brian McGee Date: Thu, 2 May 2024 11:52:01 +0100 Subject: [PATCH] doc: update usage with info about walkers. Signed-off-by: Brian McGee --- docs/usage.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/usage.md b/docs/usage.md index 7fd41db..3a34b55 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -16,6 +16,12 @@ treefmt [FLAGS] [OPTIONS] [--] [paths]... ## Flags +`--walk ` + +> The method used to traverse the files within ``. +> Default is `auto`, where we will detect if the `` is a git repository and use the `git` walker for +> traversal. If not we will fall back to the `filesystem` walker. + `--allow-missing-formatter` > Do not exit with an error if some of the configured formatters are missing.