SuperClaude Documentation

Complete guide to automating your Git documentation. One CLI that handles commit messages, changelogs, and code reviews automatically.

Get Started in 60 Seconds

1. Install SuperClaude

npm install -g superclaude

2. Setup Claude CLI (one time only)

npm install -g @anthropic-ai/claude-code && claude

Choose your auth method: Claude Pro/Team subscription, Anthropic Console, or Enterprise

3. Use anywhere, anytime

cd your-project
superclaude commit  # Perfect commit messages, instantly

Commands That Replace Hours of Work

`superclaude commit`

Stop writing "fix stuff" commits. Get AI-generated conventional commits that actually explain what you did.

Basic usage:

superclaude commit

Interactive mode (review before committing):

superclaude commit --interactive

See the AI thinking process:

superclaude commit --verbose

What it does: Analyzes your git changes, understands the context, generates conventional commit messages, stages files, commits, and pushes to current branch. One command, zero thinking.

`superclaude changelog`

Turn your messy git history into readable stories. Creates daily, weekly, and monthly summaries that stakeholders actually understand.

Generate intelligent changelogs:

superclaude changelog

With detailed progress:

superclaude changelog --verbose

Creates: CHANGELOG.md, daily summary, weekly summary, monthly overview. Focuses on user impact, not technical noise.

`superclaude review`

Get code reviews that catch what humans miss. Security vulnerabilities, performance issues, maintainability problems.

Comprehensive code analysis:

superclaude review

Analyzes: Security vulnerabilities, performance bottlenecks, code quality, maintainability. Saves detailed review to docs/code-review.md.

`superclaude readme`

Professional documentation that writes itself. Analyzes your codebase and creates comprehensive README files.

Generate project README:

superclaude readme

Includes: Project description, installation guide, usage examples, tech stack, project structure, contributing guidelines.

`superclaude docs`

Technical documentation covering architecture, deployment, troubleshooting.

`superclaude brainstorm`

AI-powered feature ideas and improvement suggestions based on your codebase.

`superclaude annotate`

Add AI-generated notes to your entire git history for better context.

`superclaude --version`

Show version info and check for updates.

Global Flags

--interactive, -i

Interactive mode - review and edit before committing

--verbose, -v

Verbose mode - see detailed progress and AI thinking process

--verify

Force full dependency verification (bypass cache)

Team Workflows

Add these to your package.json for consistent team workflows:

{
  "scripts": {
    "commit": "superclaude commit --interactive",
    "release:prep": "superclaude changelog && superclaude readme",
    "code:review": "superclaude review --verbose",
    "docs:update": "superclaude docs"
  }
}

Privacy & Security

Your Code Never Leaves Your Control

SuperClaude is a CLI tool that runs locally on your machine. There are no SuperClaude servers, databases, or analytics. Your code only goes to the services you already trust: Claude AI and GitHub.

✓

Local Processing: All operations happen on your machine

✓

No Tracking: SuperClaude doesn't collect, store, or analyze your data

✓

Open Source: Full transparency - inspect the code on GitHub

✓

Direct API Calls: SuperClaude only talks to Claude AI and GitHub - no middleman

Data Flow: Your Machine → Claude AI (for analysis) → GitHub (for commits) → Your Machine
SuperClaude Servers: None. SuperClaude is just a CLI library - no servers exist.

Common Issues

Claude authentication failed

Make sure Claude CLI is properly authenticated:

claude

Follow the prompts to authenticate with your preferred method (Pro/Team subscription, API key, or Enterprise).

Not in a git repository

SuperClaude needs to be run inside a git repository:

git init  # Initialize git repo
git remote add origin https://github.com/username/repo  # Add remote

GitHub authentication issues

For best results, set up global GitHub authentication:

# Option 1: GitHub CLI (recommended)
brew install gh && gh auth login

# Option 2: SSH key
ssh-keygen -t ed25519 -C "your@email.com"
# Then add to GitHub: https://github.com/settings/keys

Real World Examples

Daily workflow

# Make some changes
echo "new feature" >> src/feature.js

# Perfect commit message instantly
superclaude commit
# ✅ Output: "feat: add user authentication with JWT tokens"

# Update docs automatically  
superclaude readme
# ✅ Professional README with new feature documented

# Prepare for release
superclaude changelog
# ✅ Human-readable release notes

Before a release

# Get comprehensive code review
superclaude review --verbose

# Update all documentation
superclaude readme && superclaude docs

# Generate release changelog
superclaude changelog

# Everything ready for release!

Back to Home

GitHub|NPM