A command-line bug marker utility for programmers.
Project description
Bugmark
A powerful, command-line bug tracking utility designed for speed and developer workflow integration.
Features
- Severity Levels: Categorize bugs as
critical,major, orminor. - Status Lifecycle: Track bugs from
open→in-progress→resolved→closed. - 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
JSONfor simplicity orSQLitefor performance. - Git Integration:
- Link bugs to commits via Git hooks.
- Reference bugs in commit messages.
- Scan codebase for
TODOandFIXMEto 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, andMarkdown.
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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
bugmark-1.0.0.tar.gz
(12.8 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
bugmark-1.0.0-py3-none-any.whl
(13.7 kB
view details)
File details
Details for the file bugmark-1.0.0.tar.gz.
File metadata
- Download URL: bugmark-1.0.0.tar.gz
- Upload date:
- Size: 12.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a181f3ffb702dfb4eab906e8727587f026f72a69d7e3a18fa5823dfc28378c0e
|
|
| MD5 |
cbdcac254ac6f3a28244a428994c1e46
|
|
| BLAKE2b-256 |
8287ef59e8c29fb8f8a2c5cbaab784f1ddc8b4acc22fed37631263466396c48b
|
File details
Details for the file bugmark-1.0.0-py3-none-any.whl.
File metadata
- Download URL: bugmark-1.0.0-py3-none-any.whl
- Upload date:
- Size: 13.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ec3f7319f11aedcf118d6ddb26a8e29158b050325da915169388e5e7eaf90d06
|
|
| MD5 |
cd3042417575500843a7b55c757ceaa1
|
|
| BLAKE2b-256 |
d1c79c2addde486c1683a1e42fda3cbeaaa7568166ffd043173c0fbfd352d495
|