Skip to content

Home

Jump to bottom
Griffen Fargo edited this page Oct 6, 2025 · 23 revisions

🚀 Quick Start

New to coco? Start here for a complete walkthrough from installation to your first AI-generated commit.

📖 Getting Started Guide

  • Installation methods (npm, npx, global vs local)
  • First-time setup with AI provider selection
  • Your first commit walkthrough
  • Essential commands and workflows
  • Quick troubleshooting for beginners

⚙️ Configuration & Setup

Core Configuration

🔧 Configuration Overview

  • Complete configuration reference with all options
  • Multiple configuration methods (CLI, env vars, config files)
  • AI provider setup (OpenAI, Anthropic, Ollama)
  • Priority system and best practices

📁 Ignoring Files & Extensions

  • Advanced pattern matching with minimatch
  • Project-specific ignore configurations
  • Performance optimization through file filtering
  • Real-world examples for different project types

AI Providers

🏠 Using Ollama

  • Complete local AI setup guide
  • Model recommendations by hardware
  • Performance optimization and GPU acceleration
  • Privacy-focused development workflows

👥 Team & Enterprise

🤝 Team Collaboration

  • Shared configuration strategies
  • Git hooks and CI/CD integration
  • Security best practices for API keys
  • Team onboarding and training materials
  • Enterprise-scale deployment

🔧 Advanced Features

⚡ Advanced Usage

  • Custom prompts and templates
  • Multi-project configurations
  • Automation and scripting
  • Performance optimization techniques
  • Integration with development tools

🆘 Help & Support

🔍 Troubleshooting Guide

  • Common issues and solutions
  • Diagnostic commands and debugging
  • Platform-specific problems (Windows, macOS, Linux)
  • API and connectivity issues
  • Performance troubleshooting

📚 Feature Guides

Conventional Commits

  • Automatic Detection: Enables when commitlint config is found
  • Smart Formatting: Generates proper conventional commit format
  • Breaking Changes: Supports feat!: and feat(scope)!: syntax
  • Validation: Integrates with commitlint for team consistency
  • pnpm Compatibility: Automatic fallback for ES module issues

AI-Powered Features

  • Context-Aware: Analyzes staged changes for relevant commit messages
  • Multi-Provider: OpenAI, Anthropic Claude, and local Ollama models
  • Robust Parsing: Advanced JSON parsing with automatic error recovery
  • Interactive Mode: Review and edit messages before committing
  • Batch Processing: Handle multiple files and complex changesets

Developer Experience

  • Package Manager Friendly: Works with npm, yarn, and pnpm
  • IDE Integration: Compatible with VS Code, JetBrains, and terminal workflows
  • Git Hooks: Pre-commit and commit-msg hook integration
  • CI/CD Ready: GitHub Actions, GitLab CI, and Jenkins examples

🎯 Use Cases

Individual Developers

  • Consistent Commits: Never write generic commit messages again
  • Learning Tool: Understand conventional commits through examples
  • Time Saving: Generate contextual messages in seconds
  • Offline Capable: Use Ollama for complete privacy and offline work

Development Teams

  • Standardization: Enforce consistent commit message formats
  • Onboarding: Help new team members learn project conventions
  • Code Review: Better commit messages improve review efficiency
  • Release Management: Conventional commits enable automated changelogs

Enterprise Organizations

  • Compliance: Audit trails and consistent documentation
  • Security: Local AI models keep code completely private
  • Cost Control: Shared Ollama servers eliminate per-request costs
  • Integration: Seamless integration with existing development workflows

🔗 Quick Links

Essential Commands

# Interactive commit (recommended)
coco -i

# Conventional commits format
coco --conventional

# Add context for complex changes
coco -a "Resolves login timeout issue"

# Include ticket from branch name
coco --append-ticket

# Generate changelog
coco changelog

# Summarize recent work
coco recap --yesterday

Configuration Examples

# Quick setup
coco init

# Project-specific setup
coco init --scope project

# Global user setup
coco init --scope global

Common Workflows

# Daily development
git add .
coco -i

# Team workflow with validation
git add .
coco --conventional -i

# Release workflow
coco changelog --since-last-tag

📖 Additional Resources

Community & Support

Development

Integrations

  • VS Code Extension - Direct integration with your editor
  • GitHub Actions - Automated commit validation and generation
  • Commitizen Compatibility - Works alongside existing commit tools
  • Husky Integration - Git hooks for automated workflows

🆕 What's New

Recent Improvements

  • 🔧 Enhanced JSON Parsing: Automatic repair of malformed AI responses
  • 📦 pnpm Compatibility: Seamless operation with all package managers
  • 🏠 Ollama Integration: Complete local AI support with privacy focus
  • 🤖 Advanced Conventional Commits: Breaking changes, scopes, and validation
  • ⚡ Performance Optimization: Faster processing and better error handling

Coming Soon

  • Custom Prompt Templates: Create and share project-specific prompts
  • Multi-Language Support: Commit messages in different languages
  • Advanced Analytics: Team usage insights and optimization recommendations
  • IDE Extensions: Native integration with popular development environments

💡 Tips for Success

  1. Start Simple: Use default settings first, customize as you learn
  2. Use Interactive Mode: Always review AI-generated messages with coco -i
  3. Enable Conventional Commits: Better project history and automation
  4. Configure File Ignoring: Focus on meaningful changes by ignoring build artifacts
  5. Share Team Config: Use .coco.config.json for consistent team standards
  6. Monitor API Costs: Track usage and optimize with token limits or local models
  7. Integrate with Workflows: Add git hooks and CI/CD for automated quality

🎉 Get Started Today

Ready to transform your git workflow? Choose your path:

This documentation is continuously updated. For the latest information, visit the GitHub repository or join our Discord community.

Clone this wiki locally