Skip to content

ClayWarren/DevLog

Repository files navigation

🗒️ DevLog - Automatic Developer Journal

Ever forget what you worked on yesterday? DevLog remembers — so you don’t have to.

Generate a daily changelog from your Git commit history — automatically grouped by date and written to DEVLOG.md.

Demo


✨ Features

  • 📅 Groups commits by day
  • 📝 Outputs clean, shareable Markdown
  • ⚡ Runs instantly via CLI (npx @claywarren/devlog)
  • 💻 Zero configuration — works in any Git repo

🚀 Installation

Option 1 — Local Dev

git clone https://github.com/claywarren/devlog.git
cd devlog
npm install
npm run build

Option 2 — Global Install

npm install -g @claywarren/devlog

🖥 Supported Platforms (tested)

  • macOS
  • Linux
  • Windows

📦 Usage

Run inside any Git repository:

  • Using npx (without installing globally):
npx devlog
  • Or, after installing globally:
devlog

This will generate or update a file:

## 2025-08-08
- feat: add login form
- fix: crash on settings save
- docs: update API usage

⚙️ How It Works

  1. Runs git log to get commit history.
  2. Groups commits by commit date.
  3. Writes them to DEVLOG.md in reverse chronological order.

🖥 Example

$ npx devlog
✅ DEVLOG.md updated!

Output in DEVLOG.md:

## 2025-08-08
- feat: add login form
- fix: crash on settings save
- docs: update API usage

📜 License

MIT © 2025 Clay Warren

About

Automatic Developer Journal

Resources

License

Stars

Watchers

Forks

Packages

No packages published