Skip to content

1.0.0

Choose a tag to compare

View all tags
@Felix-Pedro Felix-Pedro released this 08 Dec 00:27
· 59 commits to main since this release
v1.0.0
cbfd233

CommitCraft v1.0.0 Release Notes

Release Date: December 7, 2025

After months of development, I'm thrilled to announce CommitCraft v1.0.0 - a major milestone bringing stability, new features, and comprehensive documentation to the AI-powered commit message generator.

🎉 Highlights

💡 CommitClues - Context Hints for Better Messages

A powerful new feature that lets you provide context hints to guide AI-generated commit messages. Simply add flags like --bug-desc "Fixed null pointer" or --feat-desc "Added dark mode" to generate more accurate, contextual messages:

CommitCraft --feat-desc "User authentication system"
# Generates: ✨ Add user authentication system with JWT tokens

No more generic messages - tell the AI what you changed, and it crafts the perfect commit message!

🌐 Ollama Cloud Support

Native support for Ollama's cloud service, allowing you to use powerful cloud-hosted models without local GPU requirements. Connect to https://ollama.com with proper authentication and use models like qwen3-coder:480b-cloud.

🎣 Interactive Git Hook Mode

Transform your commit workflow with interactive hooks that prompt for commit type and context:

git commit
# > What type of commit is this?
# > [b] Bug fix, [f] Feature, [d] Docs, [r] Refactor

CommitClues are now seamlessly integrated into your daily workflow!

🔧 Named Provider Profiles

Manage multiple provider configurations effortlessly. Configure local and remote Ollama instances, multiple OpenAI-compatible services, or different providers for different use cases:

[providers.work_ollama]
provider = "ollama"
host = "https://ollama.work.com"

[providers.deepseek]
provider = "openai_compatible"
model = "deepseek-chat"
host = "https://api.deepseek.com"

📚 Comprehensive Documentation

Complete rewrite of documentation including:

  • CommitClues Guide - Master context hints for better messages
  • Configuration Deep Dive - Understand merging, precedence, and templating
  • Migration Guide - Smooth upgrade path from v0.x
  • Complete API Reference - Use CommitCraft as a Python library
  • Troubleshooting - 15+ new error scenarios with solutions
  • Defaults Reference - Know exactly what's happening under the hood

🎨 Enhanced User Experience

  • Colorful CLI - Rich markup in help text with proper color support across shells
  • Version Checking - Hooks auto-detect when they're outdated
  • Debug Mode - Inspect prompts with --debug-prompt without API calls
  • Better Config Wizard - Model selection by index, visual API key input

🚀 New Features

Core Features

  • Ollama Cloud Provider - Cloud-hosted Ollama models with authentication
  • CommitClues - Context hints (--bug-desc, --feat-desc, etc.)
  • Named Provider Profiles - Multiple provider configurations
  • Interactive Git Hooks - Prompts for commit type and description
  • Hook Version Checking - Auto-detection of outdated hooks
  • Debug Mode - --debug-prompt flag to inspect prompts
  • Version Flag - --version / -v displays installed version
  • Thinking Tags Support - --show-thinking for reasoning models (DeepSeek R1, QwQ)
  • Diff Filtering - .commitcraft/.ignore to exclude files
  • Context Variables - Jinja2 templating in system prompts
  • Configuration Merging - Hierarchical config with clear precedence

UI/UX Improvements

  • Rich markup in CLI help text
  • Colorful output (forced by default with FORCE_COLOR=1)
  • Plain output mode (--no-color / -p / --plain)
  • Fun loading messages during AI generation
  • Model selection by index in config wizard
  • Visual API key input (*** masking)

Documentation

  • Complete CommitClues usage guide
  • Context variables and Jinja2 templating docs
  • Named provider profiles with real-world examples
  • Configuration precedence and merging behavior
  • Complete environment variables reference
  • Ollama Cloud step-by-step setup guide
  • Emoji configuration deep dive (simple vs full GitMoji)
  • Default model versions and provider options matrix
  • Extended troubleshooting (15+ new scenarios)
  • v0.x to v1.0.0 migration guide
  • Complete Python API reference
  • Defaults reference documentation

⚠️ Breaking Changes

1. Provider Rename

custom_openai_compatible → openai_compatible

Migration:

# Old
[models]
provider = "custom_openai_compatible"

# New
[models]
provider = "openai_compatible"

2. Model Options Structure

Extra model options are no longer named CLI arguments. Use config files:

Old (v0.x):

CommitCraft --provider ollama --top_p 0.9

New (v1.0.0):

[models.options]
top_p = 0.9

Note: Standard options (temperature, max_tokens, num_ctx) still work as CLI flags.

3. Named Provider Environment Variables

Pattern changed from PROVIDER_NICKNAME_API_KEY to NICKNAME_API_KEY

Migration:

# Old
PROVIDER_LITELLM_API_KEY=xxx

# New
LITELLM_API_KEY=xxx

See the Migration Guide for complete details.

🔧 Changes

  • Refactored CLI to use Typer for better flexibility
  • Upgraded Google GenAI dependencies to v0.2.0
  • Updated default model versions
  • Changed rich_markup_mode from "markdown" to "rich"
  • Ollama Cloud default model: qwen3-coder:480b-cloud

🐛 Fixes

  • Fixed help messages not respecting NO_COLOR environment variable
  • Fixed color output in zsh terminals
  • Properly implemented Ollama Cloud using chat API

📦 Installation

New Installation

# Basic (Ollama only)
pipx install commitcraft

# With specific providers
pipx install 'commitcraft[openai]'
pipx install 'commitcraft[groq]'
pipx install 'commitcraft[google]'

# All providers
pipx install 'commitcraft[all-providers]'

Upgrade from v0.x

# Upgrade
pipx upgrade commitcraft

# Update hooks (if using)
CommitCraft hook                # Local
CommitCraft hook --global       # Global

See the Migration Guide for detailed upgrade instructions.

📖 Quick Start (v1.0.0)

1. Install

pipx install 'commitcraft[all-providers]'

2. Configure

CommitCraft config
# Follow the interactive wizard

3. Set Up Hook (Optional)

CommitCraft hook
# Enables auto-generation on git commit

4. Use It

git add .
CommitCraft
# Or just: git commit (if hook is installed)

🎯 What's Next?

CommitCraft v1.0.0 establishes a stable foundation. Future releases will focus on:

  • Additional provider integrations
  • Enhanced emoji customization
  • Performance optimizations
  • Community-requested features

🙏 Thank You

Thank you to everyone interested in CommitCraft! This release represents a significant step forward in making AI-powered commit messages accessible and user-friendly. I look forward to your feedback and contributions as the tool grows.

📚 Resources

📄 Full Changelog

CommitCraft v1.0.0 - Craft Better Commits with AI 🚀

Assets 2
Loading