gcop-rs-0.6.0 has been yanked.

gcop-rs

AI-powered Git commit message generator and code reviewer, written in Rust.

Note: This is a Rust rewrite of the original gcop project (Python). Since the original project is no longer actively maintained, this version was created to provide better performance, reliability, and maintainability.

中文文档 | Documentation

Features

🤖 AI Commit Messages - Generate conventional commit messages using Claude, OpenAI, or Ollama
🔍 Code Review - Get AI-powered code reviews with security and performance insights
🎯 Git Aliases - Convenient shortcuts like git c, git r, git acp for streamlined workflow
🚀 Easy Setup - Interactive init command for quick configuration
🔧 Custom Providers - Support any OpenAI/Claude compatible API (DeepSeek, custom endpoints, etc.)
📝 Custom Prompts - Customize generation and review prompts with template variables
⚙️ Flexible Config - Configure via file or environment variables
🎨 Beautiful CLI - Spinner animations, colored output, and interactive prompts
🐛 Debug Mode - Verbose logging with full request/response inspection
🔐 GPG Signing - Full support for GPG commit signing via native git

Requirements

Rust 1.92.0 or later (Rust 2024 edition)
Git 2.0 or later

Quick Start

1. Installation

# Homebrew (macOS/Linux)
brew tap AptS-1547/gcop-rs
brew install gcop-rs

# pipx (Python users)
pipx install gcop-rs

# cargo-binstall (no compilation required)
cargo binstall gcop-rs

# cargo install (from source)
cargo install gcop-rs

For other installation methods, see docs/guide/installation.md.

2. Configure

Option 1: Quick setup (recommended)

gcop-rs init

This interactive wizard will:

Create config directory and file at the platform-specific location
Set secure file permissions (Unix/Linux/macOS)
Optionally install convenient git aliases

Option 2: Manual setup

Use gcop-rs config edit to open config file in your system editor, or create manually at:

Linux: ~/.config/gcop/config.toml
macOS: ~/Library/Application Support/gcop/config.toml
Windows: %APPDATA%\gcop\config.toml

[llm]
default_provider = "claude"

[llm.providers.claude]
api_key = "sk-ant-your-key-here"
model = "claude-sonnet-4-5-20250929"

Or use environment variables:

export ANTHROPIC_API_KEY="sk-ant-your-key"

See docs/guide/configuration.md for all options.

3. Use

# Generate commit message
git add .
gcop-rs commit
# Or use the alias: git c

# Review uncommitted changes
gcop-rs review
# Or use the alias: git r

# Complete workflow
git acp  # Add all, commit with AI, and push

# Use different provider
gcop-rs --provider openai commit

Git Aliases

gcop-rs provides convenient git aliases for streamlined workflow.

Installation

# Install all aliases
gcop-rs alias

# Or during initial setup
gcop-rs init  # Will prompt to install aliases

Usage

After installation, you can use these shortcuts:

git c          # AI commit message and commit
git r          # AI review uncommitted changes
git s          # Show repository statistics
git ac         # Add all changes and commit with AI
git cp         # Commit with AI and push
git acp        # Add all, commit with AI, and push
git gconfig    # Edit gcop-rs configuration
git p          # Push to remote
git pf         # Force push (safer with --force-with-lease)
git undo       # Undo last commit (keep changes staged)

Management

# List all available aliases
gcop-rs alias --list

# Reinstall (overwrite conflicts)
gcop-rs alias --force

# Remove all gcop-rs aliases
gcop-rs alias --remove --force

See docs/guide/aliases.md for detailed information on each alias.

Commands

`gcop-rs init`

Initialize gcop-rs configuration.

gcop-rs init

Interactive setup wizard that:

Creates config directory
Copies example configuration
Sets secure file permissions
Optionally installs git aliases

`gcop-rs commit`

Generate AI-powered commit message for staged changes.

gcop-rs commit              # Generate, review, and commit
gcop-rs commit --no-edit    # Skip editor
gcop-rs commit --yes        # Skip confirmation
gcop-rs commit --dry-run    # Only print message, do not commit
gcop-rs -v commit           # Verbose mode

Interactive workflow:

After generating a commit message, you can choose:

Accept - Use the generated message
Edit - Open editor to manually modify (returns to menu after editing)
Retry - Regenerate without feedback
Retry with feedback - Provide custom instructions (e.g., "use Chinese", "be more concise"). Feedback accumulates across retries for refined results
Quit - Cancel commit

Example:

$ git add .
$ gcop-rs commit

ℹ Generated commit message:
feat(auth): implement JWT token validation

Choose next action:
> Accept
  Edit
  Retry
  Retry with feedback
  Quit

`gcop-rs review`

Review code changes with AI.

gcop-rs review                   # Review uncommitted changes
gcop-rs review --commit <hash>   # Review a commit
gcop-rs review --range main..dev # Review commit range
gcop-rs review --file src/main.rs # Review a file

Output formats: --format text|json|markdown

`gcop-rs config`

Manage configuration.

# Edit config file in your default editor (with validation)
gcop-rs config edit

# Validate configuration and test provider connection
gcop-rs config validate

# Show current configuration
gcop-rs config show

config edit validates your config after saving (like visudo) and works even when config is corrupted.

Tip: Always use gcop-rs config edit instead of editing the config file directly to avoid syntax errors.

`gcop-rs alias`

Manage git aliases.

gcop-rs alias                       # Install all aliases
gcop-rs alias --list                # List available aliases
gcop-rs alias --force               # Overwrite conflicts
gcop-rs alias --remove --force      # Remove all aliases

Provides convenient shortcuts like git c, git r, git acp, etc.

See docs/guide/aliases.md for details.

`gcop-rs stats`

Show repository commit statistics.

gcop-rs stats                       # Show statistics (text format)
gcop-rs stats --format json         # Output as JSON
gcop-rs stats --format markdown     # Output as Markdown
gcop-rs stats --author "name"       # Filter by author

Displays:

Total commits and contributors
Repository time span
Top contributors with commit counts
Recent activity (last 4 weeks) with ASCII bar chart

Configuration

Config file location (platform-specific):

Linux: ~/.config/gcop/config.toml
macOS: ~/Library/Application Support/gcop/config.toml
Windows: %APPDATA%\gcop\config.toml

Example configuration with Claude API:

[llm]
default_provider = "claude"

[llm.providers.claude]
api_key = "sk-ant-your-key"
model = "claude-sonnet-4-5-20250929"
temperature = 0.3

[commit]
show_diff_preview = true
allow_edit = true

[review]
min_severity = "info"

[ui]
colored = true

For complete configuration reference, see docs/guide/configuration.md.

Advanced Features

Custom Providers

Add any OpenAI or Claude compatible API:

[llm.providers.deepseek]
api_style = "openai"
api_key = "sk-your-deepseek-key"
endpoint = "https://api.deepseek.com/v1/chat/completions"
model = "deepseek-chat"

See docs/guide/providers.md for more examples.

Custom Prompts

Customize commit message or review prompts:

[commit]
custom_prompt = """
Generate a commit message in Chinese for:
{diff}

Files: {files_changed}
Stats: +{insertions} -{deletions}
"""

See docs/guide/prompts.md for template variables and examples.

Debug Mode

Use --verbose to see detailed logs:

gcop-rs -v commit  # Shows API requests, responses, and prompts

Security Notice: Verbose mode (-v or RUST_LOG=debug) logs full API requests and responses, which may include:

Your code diffs and changes

Partial API keys in error messages

Generated commit messages

Do not share verbose logs publicly or commit them to version control.

Documentation

Installation Guide - Detailed installation instructions
Git Aliases Guide - Complete guide to git aliases
Command Reference - Detailed command documentation
Configuration Reference - Complete configuration guide
Provider Setup - Configure LLM providers
Custom Prompts - Customize AI prompts
Troubleshooting - Common issues and solutions

Requirements

Rust 1.70 or higher
Git
API key for at least one provider (Claude, OpenAI, or local Ollama)

License

MIT License - see LICENSE file for details.

Author

AptS:1547 (Yuhan Bian / 卞雨涵) apts-1547@esaps.net

Tip: Run gcop-rs --help to see all commands, or use git c after installing aliases for quick commits!

gcop-rs 0.6.0

gcop-rs

Features

Requirements

Quick Start

1. Installation

2. Configure

3. Use

Git Aliases

Installation

Usage

Management

Commands

gcop-rs init

gcop-rs commit

gcop-rs review

gcop-rs config

gcop-rs alias

gcop-rs stats

Configuration

Advanced Features

Custom Providers

Custom Prompts

Debug Mode

Documentation

Requirements

License

Author

`gcop-rs init`

`gcop-rs commit`

`gcop-rs review`

`gcop-rs config`

`gcop-rs alias`

`gcop-rs stats`