git-coco 0.22.10 → 0.23.0

package/README.md

@@ -10,140 +10,134 @@
 [![Last Commit](https://img.shields.io/github/last-commit/gfargo/coco)](https://github.com/gfargo/coco/tree/main)
 [![Discord](https://img.shields.io/discord/1176716060825767948)](https://discord.gg/KGu9nE9Ejx)
 
-Spawned by the dream to automate away the tedium of writing commit messages, `coco` has grown into a multi-facetted git assistant to expedite any developer git workflow.
+An AI-powered git assistant that generates meaningful commit messages, creates changelogs, and streamlines your development workflow.
 
-Currently `coco` generates commit messages, creates changelogs, summarizes code changes, perform code review, and more - with new features being added regularly!
+**✨ Key Features:**
 
-## Commands
-
-- **`commit`**: generates commit messages based on staged changes.
-
-- **`changelog`**: create changelogs for the current branch or a range of commits.
-
-- **`recap`**: summarize changes from working-tree, or yesterday, or in the last month, or since the last tag.
+- 🤖 **AI-Powered Commit Messages** - Generate contextual commits from your staged changes
+- 📋 **Conventional Commits** - Full support with automatic validation and formatting  
+- 🔧 **Commitlint Integration** - Seamless integration with your existing commitlint configuration
+- 🏠 **Local AI Support** - Run completely offline with Ollama (no API costs, full privacy)
+- 📦 **Package Manager Friendly** - Works with npm, yarn, and pnpm
+- 👥 **Team Ready** - Shared configurations and enterprise deployment
 
-- **`review`**: perform a code review on the changes in the working directory.
+## Quick Start
 
-- **`init`**: step by step wizard to set up `coco` globally or for a project.
-
-- **`help`**: display help for `coco` commands.
-
-## Getting Started
+```bash
+# Try without installing
+npx git-coco@latest init
 
-**`coco init`** is the first step to getting started with `coco`. It will guide you through the installation process, including setting up your OpenAI API key and configuring `coco` to your preferences.
+# Install globally  
+npm install -g git-coco
 
-```bash
-# For local project use
-npx git-coco@latest init -l project
+# Setup and configure
+coco init
 
-# For global use
-npx git-coco@latest init -l global
+# Generate your first commit
+git add .
+coco -i
 ```
 
-## Usage
+## Commands
+
+- **`coco commit`** - Generate commit messages from staged changes
+- **`coco changelog`** - Create changelogs from commit history  
+- **`coco recap`** - Summarize recent changes and activity
+- **`coco review`** - AI-powered code review of your changes
+- **`coco init`** - Interactive setup wizard
 
-### **`coco commit`**
+## Usage Examples
 
-Generates commit messages based on staged changes with intelligent commitlint integration.
+### Basic Workflow
 
 ```bash
-coco
+# Make your changes
+git add .
 
-# or 
+# Generate commit message (interactive mode recommended)
+coco -i
 
-coco commit
+# Or use stdout mode
+git commit -m "$(coco)"
 ```
 
-#### Commitlint Integration
-
-`coco` automatically detects and integrates with your project's commitlint configuration:
-
-- **Smart Detection**: Automatically finds commitlint config files (`.commitlintrc.*`, `commitlint.config.*`, or `package.json` with commitlint field)
-- **AI-Aware Rules**: Passes your commitlint rules to the AI for better compliance from the start
-- **Automatic Retry**: When validation fails, `coco` automatically retries generation with error feedback (up to 2 attempts)
-- **User-Friendly Flow**: After auto-retries, offers options to try 2 more times or edit manually
-- **Full Validation**: Both AI-generated and manually edited commit messages are validated against your rules
-
-#### Useful options
+### Conventional Commits
 
 ```bash
-# --append
-# Add content to the end of the generated commit
-coco --append "Resolves #128"
-
-# --append-ticket
-# Automatically append Jira/Linear ticket ID from the branch name to the commit message 
-coco --append-ticket
+# Enable conventional commits format
+coco --conventional
 
-# --additional
-# Add extra context before generating the commit
-coco --additional "Resolves UX bug with sign up button"
+# With additional context
+coco -a "Fixes login timeout" --conventional
 
-# --conventional
-# Force conventional commits mode (also enabled automatically with commitlint config)
-coco --conventional
+# Include ticket from branch name
+coco --append-ticket --conventional
 ```
 
-### **`coco changelog`**
-
-Creates changelogs.
+### Team Workflows
 
 ```bash
-# For the current branch
-coco changelog
+# Generate changelog for releases
+coco changelog --since-last-tag
 
-# For a specific range (using HEAD references)
-coco changelog -r HEAD~5:HEAD
+# Summarize recent work
+coco recap --yesterday
 
-# For a specific range (using commit hashes)
-coco changelog -r abc1234:def5678
-
-# For a target branch
-coco changelog -b other-branch
-
-# For all commits since the last tag
-coco changelog -t
+# Code review before committing
+coco review
 ```
 
-### **`coco recap`**
+## Configuration
 
-Summarize the working-tree, or other configured ranges
+Configure `coco` for your workflow with the interactive setup wizard:
 
 ```bash
-# Summarize all working directory changes
-coco recap
+# Setup wizard
+coco init
 
-# Or these available ranges
-coco recap --yesterday | --last-week | --last-month | --last-tag
+# Project-specific setup
+coco init --scope project
 ```
 
-### Stdout vs. Interactive Mode
-
-`coco` offers two modes of operation: **stdout** and **interactive**, defaulting to **stdout**. You can specify your preferred mode in your config file or via command line flags.
-
-```bash
-# Stdout mode
-git commit -m $(coco)
-
-# Interactive mode
-coco -i
+**AI Providers:**
+- **OpenAI** - GPT-4o, GPT-4o-mini (API key required)
+- **Anthropic** - Claude 3.5 Sonnet (API key required)  
+- **Ollama** - Local models, no API costs, full privacy
+
+**Example Configuration:**
+```json
+{
+  "mode": "interactive",
+  "conventionalCommits": true,
+  "service": {
+    "provider": "openai",
+    "model": "gpt-4o"
+  }
+}
 ```
 
-### Generate and commit all in one
+## Documentation
 
-`coco` can generate and commit your changes in one command.
+For comprehensive guides, advanced usage, and detailed configuration options, visit our complete documentation:
 
-```bash
-coco -s
-```
+### 📚 **[Coco Wiki](https://github.com/gfargo/coco/wiki)**
 
-## Configuration
+**Essential Guides:**
+- **[Getting Started](https://github.com/gfargo/coco/wiki/Getting-Started)** - Complete beginner's guide from installation to first commit
+- **[Command Reference](https://github.com/gfargo/coco/wiki/Command-Reference)** - Detailed command options and examples
+- **[Configuration Overview](https://github.com/gfargo/coco/wiki/Config-Overview)** - All configuration options and setup methods
+- **[Team Collaboration](https://github.com/gfargo/coco/wiki/Team-Collaboration)** - Enterprise deployment and team adoption strategies
 
-The `.coco.config` documentation has moved to our [wiki](https://github.com/gfargo/coco/wiki/Config-Overview). Here, you'll find detailed information on setting up and customizing your experience.
+**Advanced Resources:**
+- **[Using Ollama](https://github.com/gfargo/coco/wiki/Using-Ollama)** - Local AI setup for privacy and cost control
+- **[Advanced Usage](https://github.com/gfargo/coco/wiki/Advanced-Usage)** - Custom prompts, automation, and power-user features
+- **[Troubleshooting](https://github.com/gfargo/coco/wiki/Troubleshooting)** - Solutions for common issues and debugging
 
-### **Ignoring Files**
+### 🆘 **Need Help?**
 
-You can specify files to be ignored when generating commit messages by adding them to your config file or via command line flags.  Read more about ignoring files & extensions in the [wiki](https://github.com/gfargo/coco/wiki/Ignoring-Files-&-Extensions).
+- **[Troubleshooting Guide](https://github.com/gfargo/coco/wiki/Troubleshooting)** - Comprehensive problem-solving resource
+- **[GitHub Issues](https://github.com/gfargo/coco/issues)** - Bug reports and feature requests
+- **[Discord Community](https://discord.gg/KGu9nE9Ejx)** - Real-time help and discussion
 
 ## Contribution
 

package/dist/index.esm.mjs

@@ -47,7 +47,7 @@ import { pathToFileURL } from 'url';
 /**
  * Current build version from package.json
  */
-const BUILD_VERSION = "0.22.10";
+const BUILD_VERSION = "0.23.0";
 
 const isInteractive = (config) => {
     return config?.mode === 'interactive' || !!config?.interactive;
@@ -11557,6 +11557,10 @@ const handler$3 = async (argv, logger) => {
         },
         factory,
         parser,
+        reviewParser: (result) => {
+            // Ensure the result is properly formatted as a string for display
+            return typeof result === 'string' ? result : String(result);
+        },
         agent: async (context, options) => {
             // Select the appropriate schema based on whether conventional commits are enabled
             const schema = USE_CONVENTIONAL_COMMITS

package/dist/index.js

@@ -69,7 +69,7 @@ var readline__namespace = /*#__PURE__*/_interopNamespaceDefault(readline);
 /**
  * Current build version from package.json
  */
-const BUILD_VERSION = "0.22.10";
+const BUILD_VERSION = "0.23.0";
 
 const isInteractive = (config) => {
     return config?.mode === 'interactive' || !!config?.interactive;
@@ -11579,6 +11579,10 @@ const handler$3 = async (argv, logger) => {
         },
         factory,
         parser,
+        reviewParser: (result) => {
+            // Ensure the result is properly formatted as a string for display
+            return typeof result === 'string' ? result : String(result);
+        },
         agent: async (context, options) => {
             // Select the appropriate schema based on whether conventional commits are enabled
             const schema = USE_CONVENTIONAL_COMMITS

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-coco",
-  "version": "0.22.10",
+  "version": "0.23.0",
   "description": "zero-effort git commits with coco.",
   "author": "gfargo <ghfargo@gmail.com>",
   "license": "MIT",