Skip to content

README.md

Latest commit

 

History

History
72 lines (62 loc) · 4.42 KB

README.md

File metadata and controls

72 lines (62 loc) · 4.42 KB



DevLog

Python Platform Status CLI

DevLog is a lightweight, terminal-based tool for tracking coding issues, solutions, and lessons learned in Markdown format. It helps developers log problems, document solutions, and compile their records into a structured Markdown file.

Features 🚀

  • Track Coding Issues: Log issues with descriptions, code snippets, and tags.
  • Update & Manage Entries: Modify entries as you find solutions.
  • Compile to Markdown: Generates a well-structured PROBLEMS.md file.
  • Simple CLI Usage: Easily add, update, and manage logs from the terminal.

Installation 📥

Clone the repository:

git clone https://github.com/Programming-Sai/DevLog.git
cd DevLog

Usage ⚡

Initialize the tracker:

python main.py --init

Add a new issue:

python main.py --id 001 --title "Bug in API response" --tag pending --desc "Unexpected response format" --snippet "fetch(url)..."

Mark an issue as solved:

python main.py --id 001 --tag solved --solution-desc "Fixed by updating headers"

Compile to Markdown:

python main.py --compile

Delete an issue:

python main.py --delete <id>

Clear all issues:

python main.py --clear

List all issues:

python main.py --list

Future Enhancements ✨

  • Add searching/filtering features
  • Support multiple file formats (JSON, YAML, etc.)
  • Interactive mode for managing logs

Roadmap 🛣️

  • Basic CLI functionality
  • Markdown file generation
  • Implement search/filter features
  • Improve CLI user experience
  • Package as a standalone executable
  • Add support for multiple file formats (JSON, YAML, etc.)

Changes Made

  • Added --list to the usage section.
  • Included delete (--delete) and clear (--clear) options.
  • Updated the roadmap to reflect completed features.