Skip to content

aaravmaloo/bugmark

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bugmark

A powerful, command-line bug tracking utility designed for speed and developer workflow integration.

Features

  • Severity Levels: Categorize bugs as critical, major, or minor.
  • Status Lifecycle: Track bugs from openin-progressresolvedclosed.
  • Bug Age Tracking: Automatic warnings for [STALE] bugs (older than 30 days).
  • Owner & Deadlines: Assign bugs to owners and set due dates.
  • Comments & History: Full audit log of who changed what and when.
  • Advanced Search:
    • Filter by tag, file, status, or severity.
    • Regex & fuzzy text search in descriptions.
    • Sort by date, severity, status, or file.
  • Saved Filters: Create quick views for common queries.
  • Storage Options: Use JSON for simplicity or SQLite for performance.
  • Git Integration:
    • Link bugs to commits via Git hooks.
    • Reference bugs in commit messages.
    • Scan codebase for TODO and FIXME to auto-create bugs.
  • Analytics:
    • ASCII charts for status and severity distribution.
    • CI/CD integration: fail builds if critical bugs exist.
  • Import/Export: Support for JSON, CSV, and Markdown.

Installation

pip install bugmark

🛠 Usage

Adding a Bug

bugmark add "Fix the memory leak" --file main.py --line 42 --tag performance --severity critical --owner aarav

Listing Bugs

# List all open bugs
bugmark list

# List critical bugs in a specific file
bugmark list --file main.py --severity critical

# Search for bugs using regex
bugmark list --search "memory.*leak"

Managing Bugs

# Show details, comments, and history
bugmark show [id]

# Add a comment
bugmark comment [id] "I've identified the root cause in the allocator."

# Mark as resolved
bugmark resolve [id]

Advanced Features

# Scan for TODOs and auto-add them
bugmark scan --add

# Show bug statistics
bugmark stats

# CI Check (fails if critical bugs exist)
bugmark ci-check --threshold critical

Configuration

Create a .bugmark.json in your project root to customize storage:

{
    "storage_type": "sqlite",
    "data_dir": "./.bugmark",
    "saved_filters": {
        "urgent": {"severity": "critical", "status": "open"}
    }
}

📄 License

MIT

About

A CLI tool for resolving and maintaining all bugs in your code.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages