docs: Add debugging steps

2026-10-17 17:45:10 +02:00 · 2021-05-28 18:37:01 -05:00
parent cff8cadc6e
commit a33196d0d8
1 changed files with 16 additions and 0 deletions
@@ -89,5 +89,21 @@ typos dir/file --diff
 typos dir/file --format json
 ```

+### Debugging
+
+You can see what the effective config looks like by running
+```bash
+typos --dump-config -
+```
+
+You can then see how typos is processing your project with
+```bash
+typos --files
+typos --identifiers
+typos -- words
+```
+
+If you need to dig in more, you can enable debug logging with `-v`
+
 [Crates.io]: https://crates.io/crates/typos-cli
 [Documentation]: https://docs.rs/typos