DevLog

[pallid solar]

DevLog is a lightweight CLI tool that records your local development workflow. It captures notes, shell activity(not yet implemented), 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.

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 your filesystem~/.config/devlog/sessions/

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

# 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://[email protected]/sandbox-science/devlog.git@main

# Run the DevLog Shell
devlog

Repository: https://github.com/sandbox-science/devlog

[split flower]

Protip: take screenshot of rendered markdown and html. Go to issues, create a new issue, upload the images, copy links, dont actually create the issue, then include previews of images on markdown with  format

HR loooves demo screenshots of programs :P

[pallid solar]

You mean to include demo of them in the README or something? If so, that’s a good idea. I will do that

[split flower]

Yeah, pics or a demo video, either or

I want to see what the html looks like before I run the app yk

[pallid solar]

Make sense make sense. Will do that thanks

[split flower]

Also dont store in home, store in users app data directory or something

https://codingtechroom.com/question/how-to-locate-the-application-data-directory-on-linux-and-macos

On windows thatd be your %APPDATA%

[pallid solar]

Yeah, I’m Mac and Linux it should be stored in ~/.config already in the user filesystem. I didn’t think about windows lol

Mac also have a .config like Linux. That’s where Neo vim, vim, etc has their config settings stored too (which is the reason why I choose this directory as well).

Same for CodeAstra (the code editor in C++)

[split flower]

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

Not according to the readme

~/.config/devlog

My home directory is messy enough, dont pollute 😩

[pallid solar]

Yeah, thats the user directory. The same as the article you linked (did you read the article lol)

oh wait

ahah, okay yeah I see

I thought I did it in config but I must have messed up with CodeAstra. Going to fix that now

ahah. My bad

thanks for pointing that out

Thank you. Fixed now

(need to push the changes lol)

[split flower]

did you read the article lol

[pallid solar]

I did read it, but I thought I was storing in the .config directory, but that is actually for CodeAstra lol

Thank you for calling me out