@snapcommit/cli/README.md

Instant AI commits. Beautiful progress tracking. Never write commit messages again.

# SnapCommit

**Snap. Commit. Track.**

Instant AI commits. Beautiful progress tracking. Never write commit messages again.

[![npm version](https://badge.fury.io/js/snapcommit.svg)](https://www.npmjs.com/package/snapcommit)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## What is SnapCommit?

SnapCommit is a CLI tool that makes Git & GitHub effortless:

1. **⚡ Instant AI Commits** - Professional messages in one command (`snap`)
2. **🌍 Natural Language** - Just say what you want: "create a PR", "merge main"
3. **📊 Beautiful Stats** - Track your coding journey with gorgeous analytics
4. **🔥 Streak Tracking** - Gamification to keep you motivated
5. **🚀 Universal** - Works everywhere (any IDE, any terminal, any OS)

## Quick Start

```bash
# Install globally
npm install -g snapcommit

# Set up (adds aliases)
snapcommit setup

# Make your first commit
snap  # That's it!
```

## Installation

### Option 1: npm (Recommended)

```bash
npm install -g snapcommit
```

### Option 2: Install Scripts

**macOS / Linux:**
```bash
curl -fsSL https://snapcommit.dev/install.sh | bash
```

**Windows (PowerShell):**
```powershell
iwr https://snapcommit.dev/install.ps1 | iex
```

## Setup

After installation, run setup to integrate with your shell:

```bash
snapcommit setup
```

This adds `snap` and `sc` aliases. Restart your terminal and you're ready!

## Usage

### Interactive Mode

Type `snap` to enter interactive mode:

```bash
$ snap
⚡ SnapCommit Interactive Mode

snap> commit my authentication work
✅ feat(auth): implement user authentication system

snap> create a PR
✅ PR #42 created

snap> check ci
✅ All checks passed
```

### Just Talk to It 💬

SnapCommit is **Cursor for Git** - no commands to memorize. Just describe what you want:

```bash
snap> commit my authentication work
✅ feat(auth): implement user authentication system

snap> I messed up, go back to how it was before
✅ Reverted last commit

snap> open a pull request for this feature
✅ PR #42 created

snap> did the tests pass?
✅ All CI checks passed
```

**That's the whole point** - talk naturally, like you would to a teammate. SnapCommit figures out what you mean.

## Authentication

**SnapCommit includes built-in AI models!** No API keys needed.

1. **Sign up at:** https://snapcommit.dev/login
2. **Subscribe:** $9.99/month or $100/year
3. **Get your token:** From your dashboard
4. **Authenticate CLI:** Enter token when prompted

After installing, the CLI will guide you through authentication on first use.

## Features

- ✅ **AI Commit Messages** - Claude 4.5 Sonnet generates perfect commits
- ✅ **Natural Language Git** - No more memorizing commands
- ✅ **GitHub Integration** - PRs, CI checks, workflows, releases
- ✅ **Progress Tracking** - Streaks, heatmaps, milestones
- ✅ **Multi-Repo Support** - Switch between projects seamlessly
- ✅ **Conflict Resolution** - AI-guided merge conflict solving
- ✅ **Smart Error Handling** - Auto-retry with intelligent fixes
- ✅ **Privacy First** - Local-first, minimal data sent to AI
- ✅ **Cross-Platform** - macOS, Linux, Windows

## Pricing

- **Monthly:** $9.99/month - Unlimited AI commits, all features
- **Yearly:** $100/year - Save 17% (best value!)

## Supported Platforms

- ✅ macOS (zsh, bash, fish)
- ✅ Linux (zsh, bash, fish)
- ✅ Windows (PowerShell, Git Bash, WSL)
- ✅ Any terminal, any IDE

## Requirements

- Node.js 18+
- Git installed
- API keys (we'll help you get them)

## Documentation

Full docs at [snapcommit.dev/docs](https://snapcommit.dev/docs)

## Support

- 🐦 [Follow on X/Twitter](https://x.com/Arjun06061)
- 📧 [Email support](mailto:support@snapcommit.dev)
- 💡 [Suggestions & Feedback](https://x.com/Arjun06061)

## License

MIT © SnapCommit Team

---

**Made with ❤️ for developers who want to focus on building, not git messages.**

[Website](https://snapcommit.dev) • [X/Twitter](https://x.com/Arjun06061)