Documentation

Get started with CommitFox. Everything you need to install, configure, and use the CLI effectively.

Getting Started

Installation

Install CommitFox on macOS, Linux, or Windows.

npm install -g commitfox

Quick Start

Generate your first commit message in under a minute.

commitfox

Configuration

Customize CommitFox with a .commitfox.json file.

commitfox init

Commands

commitfox

Generate a commit message for your staged changes.

# Stage some files
git add src/index.ts

# Generate commit message
commitfox

# Output: Creates commit with AI-generated message

commitfox split

Split staged changes into multiple logical commits.

# After staging multiple changes
git add .

# See suggested splits
commitfox split

commitfox doctor

Check project health and identify issues.

# Run health checks
commitfox doctor

# Auto-fix issues
commitfox doctor --fix

commitfox checkpoint

Save work-in-progress as a named snapshot.

# Save current state
commitfox checkpoint "wip-feature"

# Resume later
commitfox checkpoint --resume

Configuration

Create a .commitfox.json in your project root to customize behavior:

{
  "conventions": "conventional",
  "types": ["feat", "fix", "docs", "chore"],
  "scopes": ["ui", "api", "auth"],
  "model": "llama3.2",
  "doctor": {
    "maxFileSize": 1048576,
    "requiredFiles": [".gitignore", "README.md"]
  }
}

Requirements

Node.js

Version 18.0.0 or higher

Git

Version 2.0 or higher

AI Model

Downloaded on first run (requires ~500MB)

Need Help?

Stuck on something? Check the GitHub repository for issues and discussions, or file a new issue if you find a bug.

View on GitHub More Resources