towl 🦉

A fast command-line tool that scans your codebase for TODO comments, lets you browse them in an interactive TUI, and optionally creates GitHub issues from them.

Features

• Interactive TUI: Browse, filter, sort, and peek at TODOs in a full-screen terminal interface
• GitHub Integration: Create GitHub issues from selected TODOs and replace comments with issue links
• Smart Detection: Finds TODO, FIXME, HACK, NOTE, and BUG comments
• Multiple Output Formats: JSON, CSV, Markdown, TOML, terminal table (non-interactive mode)
• Filtering & Sorting: Filter by TODO type, sort by file, line, type, or priority
• Fast: Async I/O, concurrent file scanning, compiled regex patterns
• Configurable: Customise file extensions, patterns, and exclusions via .towl.toml
• Context-Aware: Shows surrounding code lines and enclosing function names

Installation

cargo install towl

Quick Start

# Scan current directory (opens interactive TUI)
towl scan

# Scan in non-interactive mode (CI/scripting)
towl scan -N

# Output to JSON file
towl scan -N -f json -o todos.json

# Filter by type
towl scan -N -t todo

# Create GitHub issues from TODOs
towl scan -N -g

# Preview GitHub issues without creating them
towl scan -N -g -n

# Initialise config
towl init

# Show current config
towl config

Usage

towl scan [OPTIONS] [PATH]

Options:
  -N, --non-interactive     Disable interactive TUI mode (for CI/scripting)
  -f, --format <FORMAT>     Output format (non-interactive only) [default: terminal]
                            [possible values: table, json, csv, toml, markdown, terminal]
  -o, --output <OUTPUT>     Output file path (required for json, csv, toml, markdown)
  -t, --todo-type <TYPE>    Filter by TODO type
                            [possible values: todo, fixme, hack, note, bug]
  -v, --verbose             Enable verbose output
  -g, --github              Create GitHub issues for found TODOs
  -n, --dry-run             Preview GitHub issues without creating them

towl init [OPTIONS]

Options:
  -p, --path <PATH>         Config file path [default: .towl.toml]
  -F, --force               Overwrite existing config file

towl config                 Show current configuration

Interactive TUI

By default, towl scan opens an interactive terminal interface:

Use --non-interactive / -N to bypass the TUI for CI pipelines and scripting.

Configuration

Create a .towl.toml file in your project root (or run towl init):

[parsing]
file_extensions = ["rs", "toml", "json", "yaml", "yml", "sh", "bash"]
exclude_patterns = ["target/*", ".git/*"]
include_context_lines = 3

[github]
owner = "your-github-username"
repo = "your-repo-name"

The GitHub token can be set via the TOWL_GITHUB_TOKEN environment variable. Owner and repo are auto-detected from the git remote on towl init.

License

MIT