tickgit
A command-line tool to manage TODOs, tickets, and checklists as configuration within your codebase using git history.
What is tickgit?
tickgit is a command-line tool that helps software engineers manage latent work, such as TODOs, tickets, and checklists, directly within their codebase. It scans repositories to identify TODO comments and provides reports on pending tasks, progress summaries, and historical data using git history. The tool is designed to augment traditional project management systems by embedding task tracking alongside the code.
Software engineers and developers who want to track and manage TODOs and other latent work directly within their code repositories without relying solely on external project management tools.
Developers choose tickgit for its lightweight, code-centric approach to task management, seamless integration with git for historical tracking, and its ability to provide actionable insights into pending work directly from the command line.
Overview
Manage your repository's TODOs, tickets and checklists as config in your codebase.
Use Cases
Best For
- Tracking and managing TODO comments across large codebases
- Generating reports on pending tasks and progress within a repository
- Analyzing historical data on TODOs using git blame information
- Augmenting external project management tools like JIRA or Trello with code-integrated tracking
- Command-line based task management for developers
- Identifying stale or old TODOs that need attention
Not Ideal For
- Teams requiring collaborative web-based dashboards for task management with non-technical stakeholders
- Projects that need deep integration with external issue trackers beyond basic augmentation
- Codebases where TODOs are rarely used or inconsistently formatted across files
Pros & Cons
Pros
Detects TODO comments across the codebase and generates detailed reports with file locations and line numbers, as shown in the example output from the README.
Uses git blame to show when TODOs were added, by whom, and in which commit, providing historical context for task tracking.
Offers a straightforward CLI for viewing reports and managing tasks directly from the terminal, with usage accessible via --help.
Provides summaries of completion status and historical statistics on task evolution, aiding in project monitoring without external tools.
Cons
Currently only scans for 'TODO' comments, with support for FIXME, XXX, etc., listed as 'Coming Soon' in the README, restricting flexibility.
Lacks features like custom ignore paths or advanced settings, which are planned but not yet implemented, making it less adaptable to specific workflows.
Does not show surrounding code lines for TODOs, limiting understanding without opening files, as noted in the 'Coming Soon' section for context enhancement.
Frequently Asked Questions
Related Projects
golangci-lintFast linters runner for Go
staticcheckStaticcheck - The advanced Go linter
revive🔥 ~6x faster, stricter, configurable, extensible, and beautiful drop-in replacement for golint
errcheckerrcheck checks that you checked errors.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.