Devlog Documentation

AI-powered development log generator for git repositories

View the Project on GitHub ananno/devlog

Devlog - AI-Powered Development Log Generator

Privacy-First Changelog Generation with Local LLM Integration

License: MIT Rust GitLab Pipeline GitHub Actions


What is Devlog?

Devlog is an intelligent changelog generator that transforms your Git commit history into human-readable development logs. Unlike traditional changelog generators, Devlog analyzes actual code changes using AI while keeping your data secure through local-first processing.

Key Highlights



Quick Start

Installation

# From GitHub
git clone https://github.com/ananno/devlog.git
cd devlog && cargo build --release

# From GitLab
git clone https://gitlab.com/aice/devlog.git
cd devlog && cargo build --release

Basic Usage

# Generate changelog for current repository
devlog --from v1.0.0 --to v2.0.0

# With AI-enhanced summaries (local LLM)
devlog --from v1.0.0 --to v2.0.0 --llm ollama

# Analyze code changes with diff analysis
devlog --diff-analysis --llm ollama --from HEAD~20 --to HEAD

Four Operating Modes

Mode 1: Plain Mode (No LLM)

Generate changelogs from commit messages without AI processing.

devlog --from v1.0.0 --to v1.1.0

Output: Chronological list with unit badges [PR], [Merge], [Direct], [Tag]

Mode 2: AI-Enhanced (No Diff Analysis)

Use AI to summarize commit messages for better readability.

devlog --from v1.0.0 --to v1.1.0 --llm ollama

Output: Chronological list with AI-generated summaries

Mode 3: Diff Analysis (No Feature Grouping)

Analyze actual code changes with AI for detailed insights.

devlog --from v1.0.0 --to v1.1.0 --llm ollama --diff-analysis

Output: Detailed code change analysis with “What changed” and impact summaries

Mode 4: Feature-Grouped Analysis

Group related changes by features for high-level overview.

devlog --from v1.0.0 --to v1.1.0 --llm ollama --diff-analysis --group-features

Output: Feature-based changelog with PRs and commits organized by purpose


Why Devlog?

Privacy-First Design

Intelligent Analysis

Developer-Friendly


Example Output

Diff Analysis Mode

======================================================================
Development Log: v1.0.0 → v1.1.0
======================================================================

- [Tag] v1.0.0 Release (2024-01-01)

- [PR] Add user authentication system (2024-01-05)
  PR: #123
  • What changed: Implemented JWT-based authentication
  • Summary:
    - Added JWT token generation and validation
    - Created login and logout endpoints
    - Added middleware for protected routes
    - Integrated bcrypt for password hashing

- [Merge] Feature/dashboard integration (2024-01-08)
  PR: #125, #126
  • What changed: Merged dashboard feature with 15 commits
  • Summary:
    - Created dashboard layout components
    - Integrated analytics API
    - Added user preferences storage

- [Tag] v1.1.0 Release (2024-01-15)
  Released with: authentication system, dashboard

======================================================================
Summary: 4 units displayed (2 minor filtered)
======================================================================

Community & Support


Contributing

Contributions are welcome! Please see our Contributing Guidelines for details.


Made for privacy-conscious developers