░████░███████                      ░██                          ░████ 
░██  ░██   ░██                     ░██                            ░██ 
░██  ░██    ░██ ░███████ ░██    ░██░██        ░███████  ░████████ ░██ 
░██  ░██    ░██░██    ░██░██    ░██░██       ░██    ░██░██    ░██ ░██ 
░██  ░██    ░██░█████████ ░██  ░██ ░██       ░██    ░██░██    ░██ ░██ 
░██  ░██   ░██ ░██         ░██░██  ░██       ░██    ░██░██   ░███ ░██ 
░██  ░███████   ░███████    ░███   ░██████████░███████  ░█████░██ ░██ 
░██                                                           ░██ ░██ 
░████                                                   ░███████░████ 
                                                                      

DevLog is a lightweight CLI tool that records your local development workflow. It captures notes, shell activity, and Git actions to produce a structured, timestamped report, perfect for debugging, documentation, or reflection. The logs are recorded in text format via a JSON file. The tool can generate a Markdown and HTML report for developers to directly visualize their workflow offline directly from their browser.

Note

More about the idea on this article.

---

Features

• 📋 Start and stop sessions via DevLog shell
• 📝 Add timestamped notes during a session
• 🎟️ Add timestamped git activity during a session
• 📂 Export sessions as Markdown and HTML logs
• 📁 Organized logs stored in ~/.config/devlog/sessions/

---

User Installation

The project is not yet available on pip. However, you can install it running the following:

# Set up virtual environment (optional but recommended)
python3 -m venv .venv
source .venv/bin/activate

# Install with pip from GitHub main branch
pip install git+ssh://git@github.com/sandbox-science/devlog.git@main

Dev Mode Installation

# Clone the repository
git clone https://github.com/sandbox-science/devlog.git
cd devlog

# Set up virtual environment (optional but recommended)
python3 -m venv .venv
source .venv/bin/activate

# Install with dev dependencies
pip install -e ".[dev]"

Usage

# Initialize DevLog shell mode
devlog

# Start a session
start

# Add a note
note Working on Sandbox Science Project

# End the session and export to Markdown
stop

# Export all your logs into markdown or HTML
export md
export html

# Open a dashboard to display your logs
dashboard

# Exit DevLog shell mode
exit

• All JSON session are saved in ~/.config/devlog/sessions/{timestamp}.json
• All exported HTML sessions are saved in ~/.config/devlog/sessions/dashboard/index.html
• All exported Markdown sessions are saved in ~/.config/devlog/sessions/{timestamp}.md

Engineering Requirement Document

You can find the ERD on Proton Doc