Debrix CLI

Configuration

Debrix supports custom configuration via a YAML file. By default, it looks for a file named .debrix.yml in the project root. You can also provide a custom path using the --config flag.

Field	Type	Default	Description
pattern	String[]	['todo']	A list of TODO patterns to search for in source files
outFile	String	TODO.md	The output file path for the generated TODO list relative to the root
language	String	en	The language for CLI messages and generated output
layout	String	plain	Output layout format
exclude	String[]	- .git - .idea - .vscode - node_modules - dist - build - out - bin - vendor - third_party - venv - __pycache__ - target - coverage - cache	A list of paths or directories to exclude from scanning.
linkTemplate	String	{{filePath}}:{{lineNumber}}	A template for generating clickable links to TODOs. You can use the following placeholders: - {{filePath}} – file path relative to project root - {{lineNumber}} – line number

Supported locales

• English (en)
• Spanish (es)
• French (fr)
• German (de)
• Ukrainian (ua)
• Russian (ru)

Supported layout values

• plain
• table

Supported languages

• JavaScript/TypeScript
• Go
• Swift
• Objective-C
• C/C++
• C#
• Java
• Kotlin
• Dart
• Bash shell
• Python
• HTML
• PHP
• CSS
• Lua
• Yaml files
• Ruby
• Rust
• Scala
• Elixir
• Perl