Added AI Commit Blueprint to generate concise commit messages based on git diffs, updated documentation, and included a demo app with Streamlit for user interaction and commit message generation.

Author: MikeBirdTech

README.md

@@ -9,38 +9,80 @@
   </picture>
 </p>
 
-This blueprint guides you to ...
+# AI Commit
+
+This blueprint guides you to easily generate AI-powered git commit messages based on your code changes. It uses local LLMs via Jan AI or Ollama to analyze git diffs and suggest concise, relevant commit messages.
 
 📘 To explore this project further and discover other Blueprints, visit the [**Blueprints Hub**](https://developer-hub.mozilla.ai/).
 
-👉 📖 For more detailed guidance on using this project, please visit our [**Docs here**](https://mozilla-ai.github.io/Blueprint-template/)
+👉 📖 For more detailed guidance on using this project, please visit our [**Docs here**](https://mozilla-ai.github.io/ai-commit/)
 
 ### Built with
+
 - Python 3.10+
-- Open-Source Tool 1
-- Open-Source Tool 2
-- ...
+- [Jan AI](https://jan.ai) for a user-friendly local AI experience
+- Open-source LLMs via [Ollama](https://ollama.ai) as an alternative
+- fzf for terminal UI
 
 ## Quick-start
 
+1. Make sure you have Git, Python 3.10+, and pip installed
+2. Install the package:
+   ```bash
+   pip install ai-commit
+   ```
+3. Choose one of the following local inference options:
+
+   **Option 1: Jan AI (Default)**
+
+   - Install [Jan AI](https://jan.ai) and download a model (like Llama 3.1) through its interface
+   - Start the Jan AI application and ensure it's running
+
+   **Option 2: Ollama**
+
+   - Install [Ollama](https://ollama.ai) and pull a model:
+
+   ```bash
+   ollama pull llama3.1
+   ```
+
+4. Make changes to your git repo and run:
+
+   ```bash
+   ai-commit
+   ```
+
+   For Ollama, use:
+
+   ```bash
+   ai-commit --ollama
+   ```
 
 ## How it Works
 
+1. The tool extracts your git diff (staged changes, or unstaged if no staged changes)
+2. Sends the diff to an AI model with a prompt to generate concise commit messages
+3. Presents you with message suggestions in a terminal UI using fzf
+4. After selecting a message, commits your changes with the selected message
 
 ## Pre-requisites
 
 - **System requirements**:
+
   - OS: Windows, macOS, or Linux
   - Python 3.10 or higher
-  - Minimum RAM:
-  - Disk space:
+  - Git
+  - fzf (for terminal UI)
+  - Jan AI or Ollama for local inference
 
 - **Dependencies**:
   - Dependencies listed in `pyproject.toml`
 
-
 ## Troubleshooting
 
+- If you get `fzf: command not found`, install fzf: [fzf installation guide](https://github.com/junegunn/fzf#installation)
+- For Jan AI issues, ensure the Jan AI application is running
+- For Ollama issues, ensure the Ollama service is running and your model is pulled
 
 ## License
 

demo/app.py

@@ -1,7 +1,54 @@
+"""Demo application for AI Commit Blueprint."""
+
 import streamlit as st
+from blueprint.commit_generator import generate_commit_messages
+
+# Set page config
+st.set_page_config(
+    page_title="AI Commit Message Generator",
+    page_icon="✅",
+    layout="wide",
+)
+
+# Add title and description
+st.title("AI Commit Message Generator")
+st.subheader("Generate commit messages with AI")
+
+# Add sidebar with options
+st.sidebar.title("Settings")
+service_type = st.sidebar.radio("Select AI Service", ["ollama", "groq"])
+max_chars = st.sidebar.slider("Max Characters", 20, 150, 75)
+ollama_model = st.sidebar.text_input("Ollama Model", "llama3.1")
+groq_model = st.sidebar.text_input("Groq Model", "llama-3.1-70b-versatile")
+
+# Main content
+git_diff = st.text_area("Paste your git diff here:", height=300)
 
-from blueprint.hello import hello
+# Generate button
+if st.button("Generate Commit Messages"):
+    if git_diff:
+        with st.spinner("Generating commit messages..."):
+            try:
+                commit_messages = generate_commit_messages(
+                    diff=git_diff,
+                    max_chars=max_chars,
+                    service_type=service_type,
+                    ollama_model=ollama_model,
+                    groq_model=groq_model,
+                )
 
-st.title("Blueprint Demo")
+                # Display results
+                st.success("Generated Commit Messages:")
+                for i, message in enumerate(commit_messages, 1):
+                    st.markdown(f"**Option {i}:** {message}")
 
-st.write(hello())
+                    # Add a copy button for each message
+                    if st.button(f"Use Message {i}", key=f"use_{i}"):
+                        st.code(message)
+                        st.info(
+                            "Copy the message above and use it in your git commit command"
+                        )
+            except Exception as e:
+                st.error(f"Error generating commit messages: {e}")
+    else:
+        st.warning("Please paste a git diff first.")

demo/run.sh

@@ -20,7 +20,10 @@ stopRunningProcess() {
 
 trap stopRunningProcess EXIT TERM
 
-streamlit run ${HOME}/document-to-podcast/demo/app.py &
+# Add streamlit to dependencies for the demo
+pip install streamlit
+
+streamlit run ${HOME}/blueprint/demo/app.py &
 APP_ID=${!}
 
 wait ${APP_ID}

docs/api.md

@@ -1,3 +1,13 @@
 # API Reference
 
-"::: blueprint.hello"
+## AI Service Module
+
+::: blueprint.ai_service
+
+## Commit Generator Module
+
+::: blueprint.commit_generator
+
+## CLI Module
+
+::: blueprint.cli

docs/customization.md

@@ -6,16 +6,38 @@ This Blueprint is designed to be flexible and easily adaptable to your specific
 
 ## 🧠 **Changing the Model**
 
+You can customize the AI models used by AI Commit:
 
+### Jan AI Models (Default)
 
-## 📝 **Modifying the system Prompt**
+Set your preferred Jan AI model using the environment variable:
 
+```bash
+export JAN_MODEL="llama 3.1"  # or any other model you've downloaded
+```
 
+### Ollama Models
 
-## 💡 Other Customization Ideas
+Set your preferred Ollama model using the environment variable:
+
+```bash
+export OLLAMA_MODEL="llama3.1"  # or any other model you've pulled
+```
+
+## 📝 **Modifying the System Prompt**
 
-- other ideas..
+You can customize the prompt sent to the AI models by modifying the `generate_commit_messages` function in the `commit_generator.py` file. This allows you to:
+
+- Change the number of commit messages generated
+- Adjust the style or format of the messages
+- Add specific guidelines for your team's commit message standards
+
+## 💡 Other Customization Ideas
 
+- Add support for additional AI providers
+- Implement commit message templates
+- Add integration with commit hooks
+- Create organization-specific formatting rules
 
 ## 🤝 **Contributing to the Blueprint**
 

docs/getting-started.md

@@ -1,9 +1,96 @@
+# Getting Started with AI Commit
+
 Get started with this Blueprint using one of the options below:
 
 ---
 
-### **Option 1:**
+## Installation
+
+### Prerequisites
+
+Before you begin, make sure you have:
+
+1. **Python 3.10 or higher** installed
+2. **Git** installed and configured
+3. **fzf** installed for the terminal UI (see [installation guide](https://github.com/junegunn/fzf#installation))
+4. Either:
+   - **Jan AI** installed for local inference ([install guide](https://jan.ai/))
+   - Or **Ollama** as an alternative local inference option ([install guide](https://ollama.ai/download))
+
+### Install from PyPI
+
+The easiest way to install AI Commit is via pip:
+
+```bash
+pip install ai-commit
+```
+
+### Install from Source
+
+Alternatively, you can install from source:
+
+```bash
+git clone https://github.com/mozilla-ai/ai-commit.git
+cd ai-commit
+pip install -e .
+```
+
+## Setup
+
+### For Inference with Jan AI (Default)
+
+1. Install and launch Jan AI from [jan.ai](https://jan.ai/)
+2. Download a model (like llama 3.1) through the Jan AI interface
+3. Ensure the Jan AI application is running
+4. (Optional) Set a custom model:
+   ```bash
+   export JAN_MODEL="your-preferred-model"
+   ```
+
+### For Inference with Ollama
+
+1. Start the Ollama service
+2. Pull a model (we recommend llama3.1):
+   ```bash
+   ollama pull llama3.1
+   ```
+3. (Optional) Set a custom model:
+   ```bash
+   export OLLAMA_MODEL="your-preferred-model"
+   ```
+
+## Usage
+
+### Basic Usage
+
+1. Make changes to your files in a git repository
+2. Run:
+   ```bash
+   ai-commit
+   ```
+3. Select one of the generated commit messages using the arrow keys or number keys
+4. Press Enter to commit with the selected message, or Esc to cancel
+
+### Advanced Options
+
+```bash
+# Use Ollama instead of Jan AI
+ai-commit --ollama
+
+# Show performance analytics
+ai-commit --analytics
+
+# Use vim-style navigation in fzf
+ai-commit --vim
+
+# Use number selection for messages
+ai-commit --num
 
+# Set the maximum characters for commit messages
+ai-commit --max_chars 100
+```
 
+## What's Next?
 
-###  **Option 2:**
+- See the [Step-by-Step Guide](step-by-step-guide.md) to understand how AI Commit works
+- Learn about [customization options](customization.md) to tailor it to your needs

docs/index.md

@@ -5,30 +5,37 @@ Blueprints are customizable workflows that help developers build AI applications
 These docs are your companion to mastering this Blueprint.
 
 ### Built with
+
 - Python 3.10+
 - Tool 1
 - Tool 2
 
-
 ---
 
 ### 🚀 **Get Started Quickly**
+
 #### _Start building the Blueprint in minutes:_
+
 - **[Getting Started](getting-started.md):** Quick setup and installation instructions.
 
 ### 🔍 **Understand the System**
+
 #### _Dive deeper into how the Blueprint works:_
+
 - **[Step-by-Step Guide](step-by-step-guide.md):** A detailed breakdown of the system’s design and workflow.
 - **[API Reference](api.md):** Explore the technical details of the core modules.
 
 ### 🎨 **Make It Yours**
+
 #### _Customize the Blueprint to fit your needs:_
+
 - **[Customization Guide](customization.md):** Tailor project parameters to fit your needs
 
 ### 🌟 **Join the Community**
+
 #### _Help shape the future of Blueprints:_
-- **[Future Features & Contributions](future-features-contributions.md):** Learn about exciting upcoming features and how to contribute to the project.
 
+- **[Future Features & Contributions](future-features-contributions.md):** Learn about exciting upcoming features and how to contribute to the project.
 
 Have more questions? Reach out to us on Discord and we'll see how we can help: