### Example: What You Type

Source: https://github.com/f/git-rewrite-commits/blob/master/QUICK_START.md

Example of commands to add a file and initiate a commit.

```bash
git add src/auth.ts
git commit
```

--------------------------------

### Example: What You Get

Source: https://github.com/f/git-rewrite-commits/blob/master/QUICK_START.md

Example of an AI-generated commit message that appears in the editor.

```text
feat(auth): implement JWT token validation middleware

# ✨ AI-generated commit message above
# Feel free to edit as needed before saving
# 
# Files being committed:
# M       src/auth.ts
```

--------------------------------

### Start Committing with AI

Source: https://github.com/f/git-rewrite-commits/blob/master/QUICK_START.md

Demonstrates the basic workflow of adding files and committing, triggering the AI message generation.

```bash
git add .
git commit
# ✨ AI message appears automatically in your editor!
```

--------------------------------

### Quick Start (No Installation Required)

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Execute the tool directly using npx without global installation.

```bash
npx git-rewrite-commits
# or shorter:
npx grec
```

--------------------------------

### Troubleshooting: Hooks Not Working

Source: https://github.com/f/git-rewrite-commits/blob/master/QUICK_START.md

Commands to check if hooks are installed and to reinstall them.

```bash
# Check if installed
ls -la .git/hooks/

# Reinstall
npx git-rewrite-commits --install-hooks
```

--------------------------------

### Troubleshooting: API Key Not Set

Source: https://github.com/f/git-rewrite-commits/blob/master/QUICK_START.md

Command to set the API key and instructions to make it permanent.

```bash
export OPENAI_API_KEY="sk-..."
# Add to ~/.bashrc or ~/.zshrc to make permanent
```

--------------------------------

### Uninstall Hooks

Source: https://github.com/f/git-rewrite-commits/blob/master/QUICK_START.md

Removes the installed git hooks.

```bash
rm .git/hooks/prepare-commit-msg
rm .git/hooks/post-commit
rm .git/hooks/pre-push
```

--------------------------------

### Troubleshooting: Want Different Template

Source: https://github.com/f/git-rewrite-commits/blob/master/QUICK_START.md

Commands to configure a custom commit template per repository or globally.

```bash
# Per repository
git config hooks.commitTemplate "🚀 feat: message"

# Global (all repositories)
git config --global hooks.commitTemplate "feat(scope): message"
```

--------------------------------

### Installation

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Install the git-rewrite-commits package using npm.

```bash
npm install git-rewrite-commits
```

--------------------------------

### Install and Run

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/README.md

Install and run the git-rewrite-commits tool using npx.

```bash
npx git-rewrite-commits
```

--------------------------------

### Set API Key

Source: https://github.com/f/git-rewrite-commits/blob/master/QUICK_START.md

Sets the OpenAI API key as an environment variable.

```bash
export OPENAI_API_KEY="your-api-key-here"
```

--------------------------------

### Set Commit Language

Source: https://github.com/f/git-rewrite-commits/blob/master/QUICK_START.md

Configures the language for AI-generated commit messages.

```bash
git config hooks.commitLanguage "es"  # Spanish
git config hooks.commitLanguage "fr"  # French
git config hooks.commitLanguage "ja"  # Japanese
```

--------------------------------

### Set Team Commit Template

Source: https://github.com/f/git-rewrite-commits/blob/master/QUICK_START.md

Configures a custom commit message template for the current repository.

```bash
git config hooks.commitTemplate "[JIRA-XXX] feat: message"
```

--------------------------------

### Command Examples

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Examples of using the git-rewrite-commits command with various options.

```bash
# Using the full command name
npx git-rewrite-commits [options]

# Or using the short alias (grec)
npx grec [options]

# Rewrite entire git history
npx git-rewrite-commits

# Preview changes without applying (dry run)
npx git-rewrite-commits --dry-run

# Generate commit message for staged changes
npx git-rewrite-commits --staged

# Process only last 10 commits
npx git-rewrite-commits --max-commits 10

# Use custom AI model
npx git-rewrite-commits --model gpt-4

# Use local AI with Ollama
npx git-rewrite-commits --provider ollama

# Install/update git hooks
npx git-rewrite-commits --install-hooks
```

--------------------------------

### Global Installation

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Install the tool globally for command-line access.

```bash
# Full command name
npm install -g git-rewrite-commits

# Or install the short alias (grec = git-rewrite-commits)
npm install -g grec

# Both work identically:
git-rewrite-commits --help
grec --help  # Same thing, just shorter!
```

--------------------------------

### Installation

Source: https://github.com/f/git-rewrite-commits/blob/master/packages/grec/README.md

Install the grec command globally using npm.

```bash
npm install -g grec
```

--------------------------------

### OpenAI Provider Initialization

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Example of initializing GitCommitRewriter with the OpenAI provider.

```typescript
const rewriter = new GitCommitRewriter({
  provider: 'openai',
  apiKey: 'sk-...',  // Your OpenAI API key
  model: 'gpt-4'     // or 'gpt-3.5-turbo'
});
```

--------------------------------

### Quick examples

Source: https://github.com/f/git-rewrite-commits/blob/master/packages/grec/README.md

Demonstrates common usage scenarios for the grec command.

```bash
# Rewrite commit history with AI
grec

# Preview changes (dry run)
grec --dry-run

# Install git hooks
grec --install-hooks

# Generate message for staged changes
grec --staged

# Use local AI with Ollama
grec --provider ollama
```

--------------------------------

### Install dependencies

Source: https://github.com/f/git-rewrite-commits/blob/master/CONTRIBUTING.md

Command to install project dependencies using npm.

```bash
npm install
```

--------------------------------

### Manual Installation (Windows)

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Manual steps to copy the pre-commit and prepare-commit-msg hooks on Windows.

```cmd
copy hooks\pre-commit.bat .git\hooks\pre-commit
copy hooks\prepare-commit-msg.bat .git\hooks\prepare-commit-msg
```

--------------------------------

### Install Git Hooks

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/README.md

Install the git hooks for git-rewrite-commits.

```bash
npx git-rewrite-commits --install-hooks
```

--------------------------------

### Real-World Examples: Automatic Commit Message Generation

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Setup for automatic commit message generation using pre-commit and prepare-commit-msg hooks.

```bash
# Install the hooks (using either command)
npx git-rewrite-commits --install-hooks
# or
npx grec --install-hooks

# Enable them (opt-in for security)
git config hooks.preCommitPreview true    # Preview before commit
git config hooks.prepareCommitMsg true    # Auto-generate in editor

# Configure provider
git config hooks.commitProvider ollama  # or use OpenAI with OPENAI_API_KEY
git config hooks.providerModel llama3.2  # Optional: specify model
```

--------------------------------

### prepare-commit-msg Hook Installation

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Instructions for manually installing the prepare-commit-msg hook on Unix-like systems.

```bash
cp hooks/prepare-commit-msg .git/hooks/
chmod +x .git/hooks/prepare-commit-msg
```

--------------------------------

### Manual Installation (Unix/macOS/Linux)

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Manual steps to copy and make executable the pre-commit and prepare-commit-msg hooks on Unix-like systems.

```bash
cp hooks/pre-commit .git/hooks/
cp hooks/prepare-commit-msg .git/hooks/
chmod +x .git/hooks/*
```

--------------------------------

### Selective Rewriting Example

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Example of configuring the rewriter to process only the last 10 commits and not skip well-formed ones.

```typescript
// Only rewrite the last 10 commits
const rewriter = new GitCommitRewriter({
  maxCommits: 10,
  skipWellFormed: false  // Process all commits
});
```

--------------------------------

### Install git-rewrite-commits

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Command to install the git-rewrite-commits tool globally using npm or npx.

```bash
npm install -g git-rewrite-commits
# or use npx (no installation needed)
```

--------------------------------

### Install git hooks

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Install git hooks using the full command name or the short alias.

```bash
npx git-rewrite-commits --install-hooks
# or
npx grec --install-hooks
```

--------------------------------

### pre-commit Hook Installation

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Instructions for manually installing the pre-commit hook on Unix-like systems.

```bash
cp hooks/pre-commit .git/hooks/
chmod +x .git/hooks/pre-commit
```

--------------------------------

### Example COMMIT_MESSAGE.md

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Example of a COMMIT_MESSAGE.md file for project-specific commit message guidelines.

```markdown
# Project Commit Guidelines

## Requirements
- Use conventional commits with these scopes: auth, api, ui, db
- Include ticket numbers when available (e.g., JIRA-123)
- Security changes must be clearly marked
- Breaking changes need BREAKING CHANGE in the message

## Project Context
This is a financial services API that handles sensitive data.
Emphasize security, compliance, and performance in commit messages.
```

--------------------------------

### Basic Usage

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Example of initializing GitCommitRewriter and using its methods to rewrite history and generate commit messages for staged changes.

```typescript
import { GitCommitRewriter } from 'git-rewrite-commits';

const rewriter = new GitCommitRewriter({
  provider: 'openai',  // or 'ollama'
  apiKey: process.env.OPENAI_API_KEY,
  model: 'gpt-4',  // optional, defaults to gpt-3.5-turbo
  dryRun: false,
  verbose: true
});

// Rewrite history
await rewriter.rewriteHistory();

// Generate message for staged changes
const message = await rewriter.generateForStaged();
console.log(message);
```

--------------------------------

### generateForStaged Method

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Example of calling the generateForStaged method to get a commit message for staged changes.

```typescript
const message = await rewriter.generateForStaged();
// Returns: "feat(auth): add JWT token validation"
```

--------------------------------

### Real-World Examples: Manual Rewriting for Existing Commits

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Example of cleaning up the last few commits before pushing.

```bash
# Clean up the last 5 commits before pushing
echo "🔧 Improving commit messages before push..."
npx git-rewrite-commits --max-commits 5 --dry-run

echo "Apply changes? (y/n)"
read answer
if [ "$answer" = "y" ]; then
```

--------------------------------

### Version Pinning in package.json

Source: https://github.com/f/git-rewrite-commits/blob/master/SECURITY.md

Example of how to pin the tool's version in the devDependencies section of package.json.

```json
"devDependencies": {
  "git-rewrite-commits": "0.4.0"
}
```

--------------------------------

### Preparing for Open Source

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Example of fixing all commits with a custom template, reviewing changes, and force pushing.

```bash
# Fix all commits with custom template
npx git-rewrite-commits \
  --template "feat(scope): message" \
  --language en \
  --no-skip-well-formed

# Review the changes
git log --oneline -20

# If satisfied, force push
git push --force-with-lease origin main
```

--------------------------------

### Custom Prompt Usage

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Example of overriding AI behavior with a custom prompt.

```typescript
const rewriter = new GitCommitRewriter({
  prompt: 'Generate a commit message with emojis and enthusiasm'
});

// Generates: "✨ feat(ui): Add amazing new dashboard! 🚀"
```

--------------------------------

### Message Replacement Example

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Demonstrates how the AI commit message preview and replacement works, showing the user's input, the AI's suggested message, and the final result.

```bash
# You type:
git commit -m "blabla"

# pre-commit shows:
🤖 AI Commit Message Preview
Suggested commit message:
fix(hooks): resolve coordination issue between pre-commit and prepare-commit-msg
This will REPLACE your commit message when you confirm.
Continue with commit? (y/n) y

# Result: Your "blabla" is replaced with the AI message!
```

--------------------------------

### Multi-language Support

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Example of configuring the rewriter to generate commit messages in Spanish.

```typescript
const rewriter = new GitCommitRewriter({
  language: 'es'  // Spanish
});

// Generates: "feat(auth): añadir validación de token JWT"
```

--------------------------------

### Basic Usage

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Example of how to use git-rewrite-commits for basic improvements.

```bash
npx git-rewrite-commits --dry-run --max-commits 10
npx git-rewrite-commits --max-commits 10
git push --force-with-lease origin feature-branch
```

--------------------------------

### Template Usage

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Example of using a custom template to format commit messages.

```typescript
const rewriter = new GitCommitRewriter({
  template: '[JIRA-{ticket}] {type}: {description}'
});

// Generates: "[JIRA-123] feat: add user authentication"
```

--------------------------------

### Configure Ollama for local models

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Commands to download a model and start the Ollama server for local AI model usage.

```bash
# Install Ollama from https://ollama.ai
ollama pull llama3.2  # Download the model
ollama serve         # Start Ollama server
```

--------------------------------

### Conventional Commits Examples

Source: https://github.com/f/git-rewrite-commits/blob/master/CONTRIBUTING.md

Examples of commit messages following the Conventional Commits specification.

```bash
feat: add support for GPT-4 vision model
fix: handle empty commit messages properly
docs: update installation instructions
refactor: extract message generation logic
test: add tests for backup creation
chore: update dependencies
```

--------------------------------

### Ollama Provider Initialization

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Example of initializing GitCommitRewriter with the Ollama provider for local model usage.

```typescript
const rewriter = new GitCommitRewriter({
  provider: 'ollama',
  model: 'llama3.2',  // or any Ollama model
  ollamaUrl: 'http://localhost:11434'
});
```

--------------------------------

### Very Quick Example

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Demonstrates how to use the tool to rewrite a commit message for staged changes, assuming OPENAI_API_KEY is set.

```bash
git add -A
git commit -m "$(npx -y grec --quiet --staged --skip-remote-consent)"

> [main 9979e7e] feat(specs): update subscription status handling in webhook controller
3 files changed, 432 insertions(+), 9 deletions(-)
create mode 100644 spec/controllers/webhooks_spec.rb

git push origin master
```

--------------------------------

### rewriteHistory Method

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Example of calling the rewriteHistory method and logging the results.

```typescript
const result = await rewriter.rewriteHistory();
console.log(`Improved ${result.improved} commits`);
console.log(`Skipped ${result.skipped} well-formed commits`);
```

--------------------------------

### Hooks Configuration via Environment Variables

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Examples of environment variables for configuring the Git commit provider, model, template, and language.

```bash
# Unix/macOS/Linux
export GIT_COMMIT_PROVIDER="ollama"  # or "openai"
export GIT_COMMIT_MODEL="gpt-4"  # or "llama3.2"
export GIT_COMMIT_TEMPLATE="[JIRA-XXX] feat: message"
export GIT_COMMIT_LANGUAGE="es"
export OLLAMA_URL="http://192.168.1.100:11434"  # Custom Ollama server URL
```

--------------------------------

### Error Handling

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Example of a try-catch block to handle potential errors during commit rewriting.

```typescript
try {
  await rewriter.rewriteHistory();
} catch (error) {
  if (error.message.includes('API key')) {
    console.error('Invalid API key');
  } else if (error.message.includes('git repository')) {
    console.error('Not in a git repository');
  } else {
    console.error('Error:', error.message);
  }
}
```

--------------------------------

### Using Pinned Version in Hooks

Source: https://github.com/f/git-rewrite-commits/blob/master/SECURITY.md

Example of how to use a specific pinned version of the tool within git hooks.

```bash
npx git-rewrite-commits@0.4.0 --staged
```

--------------------------------

### CI/CD Integration

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Example of integrating git-rewrite-commits into a CI pipeline for Pull Request validation.

```yaml
- name: Check Commit Quality
  run: |
    npx git-rewrite-commits --dry-run --max-commits ${{ github.event.pull_request.commits }}
    # This will show which commits would be improved
```

--------------------------------

### Committing Hooks to the Repo

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Steps to commit Git hooks to a repository and have team members install them.

```bash
# Create a .githooks directory
mkdir .githooks
cp hooks/* .githooks/

# Team members can then install with:
git config core.hooksPath .githooks
git config hooks.preCommitPreview true   # Enable preview
git config hooks.prepareCommitMsg true   # Enable generation
```

--------------------------------

### Test on a sample repository

Source: https://github.com/f/git-rewrite-commits/blob/master/CONTRIBUTING.md

Steps to set up a test repository and run the tool in dry-run mode.

```bash
# Create a test repo
mkdir test-repo && cd test-repo
git init
# Create some commits
echo "test" > file.txt && git add . && git commit -m "bad message 1"
echo "test2" > file2.txt && git add . && git commit -m "bad message 2"

# Run the tool in dry-run mode
npx .. --dry-run --api-key "your-api-key"
```

--------------------------------

### Custom Provider Implementations

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Demonstrates how to create and use a custom AI provider, specifically an Ollama provider with the 'codellama' model, using environment variables for configuration.

```typescript
import { createProvider } from 'git-rewrite-commits/providers';

const customProvider = createProvider({
  provider: 'ollama',
  model: 'codellama',
  ollamaUrl: process.env.OLLAMA_URL
});
```

--------------------------------

### Build the project

Source: https://github.com/f/git-rewrite-commits/blob/master/CONTRIBUTING.md

Command to build the project using npm.

```bash
npm run build
```

--------------------------------

### Enable Git Hooks

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/SECURITY.md

Explicitly enable git hooks for security.

```bash
# Hooks must be explicitly enabled
git config hooks.preCommitPreview true    # Enable preview hook
git config hooks.prepareCommitMsg true    # Enable generation hook
```

--------------------------------

### Complete usage

Source: https://github.com/f/git-rewrite-commits/blob/master/packages/grec/README.md

Lists all available options for the grec command, which are compatible with git-rewrite-commits.

```bash
# All options from git-rewrite-commits work:
grec [options]

Options:
  -h, --help               Show help
  -V, --version           Show version
  -d, --dry-run           Preview changes without applying
  -v, --verbose           Show detailed output
  -b, --branch <branch>   Target branch (default: current)
  -m, --max-commits <n>   Process only last n commits
  -s, --staged            Generate message for staged changes
  --skip-backup           Don't create backup branch
  --skip-well-formed      Skip already well-formed commits (default)
  --no-skip-well-formed   Process all commits
  --min-quality <n>       Min quality score (0-10, default: 7)
  --provider <provider>   AI provider: openai/ollama (default: openai)
  --model <model>         AI model to use
  --template <template>   Commit message template
  --language <lang>       Output language (default: en)
  --prompt <prompt>       Custom AI prompt
  --install-hooks         Install git hooks
  --skip-remote-consent   Skip consent prompt (for automation)
```

--------------------------------

### Configure for Local Processing with Ollama

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/SECURITY.md

Configure git-rewrite-commits to use Ollama for completely local AI processing.

```bash
# Configure for local processing
git config hooks.commitProvider ollama
ollama pull llama3.2
ollama serve
```

--------------------------------

### Test with npx

Source: https://github.com/f/git-rewrite-commits/blob/master/CONTRIBUTING.md

Command to test the project using npx.

```bash
npx . --help
```

--------------------------------

### Review with Dry Run

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/SECURITY.md

Command-line interface command to review changes with a dry run before applying them.

```bash
npx git-rewrite-commits --dry-run
```

--------------------------------

### Automation-Friendly Configuration

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Sets up the GitCommitRewriter for use in CI/CD pipelines by disabling interactive prompts and backup branches, and enabling a dry run for safety.

```typescript
// For CI/CD pipelines
const rewriter = new GitCommitRewriter({
  skipRemoteConsent: true,  // No interactive prompts
  skipBackup: true,         // Don't create backup branches
  dryRun: true             // Safety first
});
```

--------------------------------

### Additional Configuration

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Optional configurations for template format, language, specific models, and custom Ollama server URLs.

```bash
# Set your template format
git config hooks.commitTemplate "[JIRA-XXX] feat: message"

# Set language
git config hooks.commitLanguage "es"  # Spanish, French, etc.

# Set specific model
git config hooks.providerModel "gpt-4"  # or "gpt-3.5-turbo", "llama3.2", etc.

# Set custom Ollama server URL (if not using localhost:11434)
git config hooks.ollamaUrl "http://192.168.1.100:11434"
```

--------------------------------

### Use Ollama for Local Processing (CLI)

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/SECURITY.md

Command-line interface command to use Ollama for local processing.

```bash
npx git-rewrite-commits --provider ollama
```

--------------------------------

### Constructor Options Interface

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

TypeScript interface defining the available options for the GitCommitRewriter constructor.

```typescript
interface RewriteOptions {
  provider?: 'openai' | 'ollama';
  apiKey?: string;
  model?: string;
  ollamaUrl?: string;
  branch?: string;
  dryRun?: boolean;
  verbose?: boolean;
  maxCommits?: number;
  skipBackup?: boolean;
  skipWellFormed?: boolean;
  minQualityScore?: number;
  template?: string;
  language?: string;
  prompt?: string;
  skipRemoteConsent?: boolean;
}
```

--------------------------------

### Debugging with Verbose Mode

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Illustrates how to enable verbose mode for detailed output from the GitCommitRewriter, either by setting a configuration option or an environment variable.

```typescript
const rewriter = new GitCommitRewriter({
  verbose: true
});

// Or set environment variable
process.env.DEBUG = 'git-rewrite-commits:*';
```

--------------------------------

### TypeScript Definitions Import

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Shows how to import TypeScript definitions for GitCommitRewriter, RewriteOptions, CommitInfo, and AIProvider from the 'git-rewrite-commits' library.

```typescript
import { 
  GitCommitRewriter,
  RewriteOptions,
  CommitInfo,
  AIProvider 
} from 'git-rewrite-commits';
```

--------------------------------

### Run in development mode

Source: https://github.com/f/git-rewrite-commits/blob/master/CONTRIBUTING.md

Command to run the project in development mode with options.

```bash
npm run dev -- [options]
```

--------------------------------

### Configure AI provider

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Configure your AI provider, including OpenAI, Ollama, or a custom Ollama server.

```bash
# Option A: OpenAI (sends data to remote API)
export OPENAI_API_KEY="your-api-key"  # Unix/macOS
# set OPENAI_API_KEY="your-api-key"    # Windows

# Option B: Ollama (local processing, recommended for sensitive repos)
ollama pull llama3.2
ollama serve

# Option C: Ollama on a custom server/port
export OLLAMA_URL="http://192.168.1.100:11434"  # Unix/macOS
# set OLLAMA_URL=http://192.168.1.100:11434     # Windows
```

--------------------------------

### Configure Ollama on a custom server/port

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Git configuration commands and environment variable for specifying a custom Ollama server URL.

```bash
# If Ollama is running on a different machine or port
git config hooks.commitProvider ollama
git config hooks.ollamaUrl "http://192.168.1.100:11434"

# Or use environment variable
export OLLAMA_URL="http://192.168.1.100:11434"
```

--------------------------------

### Enable Hooks

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/README.md

Enable git hooks for previewing and auto-generating commit messages.

```bash
git config hooks.preCommitPreview true    # Preview before commit
git config hooks.prepareCommitMsg true    # Auto-generate messages
```

--------------------------------

### Recommended for sensitive repositories

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Use local Ollama instead of remote APIs for enhanced privacy and security.

```bash
git config hooks.commitProvider ollama
git config hooks.providerModel gemma3

ollama pull gemma3
olama serve
```

--------------------------------

### Configuration Options

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/index.html

These commands configure the git-rewrite-commits tool for different functionalities.

```bash
git config hooks.preCommitPreview true
git config hooks.prepareCommitMsg true
git config hooks.commitProvider ollama
```

--------------------------------

### Demo: Rewrite History

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/index.html

Demonstrates the rewrite history functionality with a dry run.

```javascript
const demos = {
  rewrite: [
    { type: 'command', text: 'npx git-rewrite-commits --dry-run', delay: 0 },
    { type: 'output', text: '', delay: 500 },
    { type: 'output', text: '🔍 Analyzing git repository...', delay: 700, class: 'highlight' },
    { type: 'output', text: '📝 Found 12 commits to process', delay: 1000 },
    { type: 'output', text: '', delay: 1200 },
    { type: 'output', text: 'Processing commits:', delay: 1400 },
    { type: 'output', text: '    [10%] abc1234: ✨ "update" → "feat(auth): implement JWT authentication"', delay: 1700, class: 'success' },
    { type: 'output', text: '    [20%] def5678: ✨ "fix bug" → "fix(api): resolve null pointer in user endpoint"', delay: 2100, class: 'success' },
    { type: 'output', text: '    [30%] ghi9012: ℹ️ Well-formed commit, skipping', delay: 2500, class: 'warning' },
    { type: 'output', text: '    [40%] jkl3456: ✨ "changes" → "refactor(ui): reorganize component structure"', delay: 2900, class: 'success' },
    { type: 'output', text: '    [50%] mno7890: ✨ "update readme" → "docs: add installation instructions"', delay: 3300, class: 'success' },
    { type: 'output', text: '    [60%] pqr1234: ℹ️ Well-formed commit, skipping', delay: 3700, class: 'warning' },
    { type: 'output', text: '    [70%] stu5678: ✨ "test" → "test: add unit tests for auth service"', delay: 4100, class: 'success' },
    { type: 'output', text: '    [80%] vwx9012: ✨ "css" → "style: improve button hover effects"', delay: 4500, class: 'success' },
    { type: 'output', text: '    [90%] yza3456: ℹ️ Well-formed commit, skipping', delay: 4900, class: 'warning' },
    { type: 'output', text: '    [100%] bcd7890: ✨ "deploy" → "ci: configure GitHub Actions workflow"', delay: 5300, class: 'success' },
    { type: 'output', text: '', delay: 5500 },
    { type: 'output', text: '✅ Dry run complete! 7 commits would be improved.', delay: 5700, class: 'success' },
    { type: 'output', text: '💡 Run without --dry-run to apply changes', delay: 6000, class: 'highlight' }
  ],
  hooks: [
    { type: 'command', text: 'npx git-rewrite-commits --install-hooks', delay: 0 },
    { type: 'output', text: '', delay: 500 },
    { type: 'output', text: '🔍 Checking git repository...', delay: 700, class: 'highlight' },
    { type: 'output', text: '✅ Git repository detected', delay: 1000, class: 'success' },
    { type: 'output', text: '', delay: 1200 },
    { type: 'output', text: '📦 Installing git hooks...', delay: 1400, class: 'highlight' },
    { type: 'output', text: ' ✅ pre-commit installed (preview)', delay: 1800, class: 'success' },
    { type: 'output', text: ' ✅ prepare-commit-msg installed (auto-generate)', delay: 2200, class: 'success' },
    { type: 'output', text: '', delay: 2400 },
    { type: 'output', text: '🎉 Git hooks installed successfully!', delay: 2600, class: 'success' },
    { type: 'output', text: '', delay: 2800 },
    { type: 'output', text: '⚠️ IMPORTANT: Hooks are opt-in for security', delay: 3000, class: 'warning' },
    { type: 'output', text: '', delay: 3200 },
    { type: 'output', text: 'Enable the hooks you want:', delay: 3400, class: 'highlight' }
```

--------------------------------

### Enable Hooks

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Git configuration commands to enable the pre-commit preview and automatic message generation features.

```bash
# Enable preview before commit
git config hooks.preCommitPreview true

# Enable automatic message generation
git config hooks.prepareCommitMsg true
```

--------------------------------

### Global Security Settings

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/SECURITY.md

Global git configuration settings for security, such as always using Ollama or ensuring explicit consent for remote data transfer.

```bash
# Always use Ollama for all repositories
git config --global hooks.commitProvider ollama

# Never send data without explicit consent
git config --global hooks.skipRemoteConsent false
```

--------------------------------

### Enabling Git Hooks Securely

Source: https://github.com/f/git-rewrite-commits/blob/master/SECURITY.md

Commands to enable various git hooks and configure local processing with Ollama.

```bash
# Enable prepare-commit-msg (generates messages for new commits)
git config hooks.prepareCommitMsg true

# Enable post-commit (improves messages after commits)
git config hooks.postCommitRewrite true

# Use local processing with Ollama (recommended for sensitive repos)
git config hooks.commitProvider ollama
```

--------------------------------

### Enforce Commit Template

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/SECURITY.md

Configuration to enforce consistent commit message formats for teams.

```bash
git config hooks.commitTemplate "type(scope): message"
```

--------------------------------

### Run the CLI locally

Source: https://github.com/f/git-rewrite-commits/blob/master/CONTRIBUTING.md

Command to run the compiled CLI locally.

```bash
node dist/cli.js --help
```

--------------------------------

### Stage Changes

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Staging files before committing.

```bash
git add src/index.ts
```

--------------------------------

### Set OpenAI API Key (Windows)

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Command for setting the OpenAI API key on Windows.

```cmd
set OPENAI_API_KEY="your-api-key-here"
```

--------------------------------

### Publishing a new version

Source: https://github.com/f/git-rewrite-commits/blob/master/CONTRIBUTING.md

Steps for maintainers to publish a new version of the package.

```bash
git tag v1.x.x
git push origin v1.x.x
```

--------------------------------

### Configure git to use Ollama

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Git configuration commands to set the commit provider to Ollama.

```bash
git config hooks.commitProvider ollama
```

--------------------------------

### Per-Repository Security Settings

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/SECURITY.md

Per-repository git configuration settings for security, such as setting the commit provider or disabling specific hooks for a particular repository.

```bash
# Configure for a specific repository
cd /path/to/sensitive/repo
git config hooks.commitProvider ollama
git config hooks.prepareCommitMsg false  # Disable for this repo
```

--------------------------------

### Global Git Configuration

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Configuring Git commit hooks globally for all repositories.

```bash
git config --global hooks.commitProvider "openai"
git config --global hooks.providerModel "gpt-4"
git config --global hooks.commitTemplate "feat(scope): message"
git config --global hooks.commitLanguage "en"
git config --global hooks.ollamaUrl "http://192.168.1.100:11434"  # Custom Ollama server URL
```

--------------------------------

### Verify Redaction

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/SECURITY.md

Command-line interface command to see what would be sent with redaction applied, including verbose output.

```bash
# See what would be sent (with redaction applied)
npx git-rewrite-commits --staged --dry-run --verbose
```

--------------------------------

### Fork and clone the repository

Source: https://github.com/f/git-rewrite-commits/blob/master/CONTRIBUTING.md

Steps to fork and clone the git-rewrite-commits repository.

```bash
git clone https://github.com/f/git-rewrite-commits.git
cd git-rewrite-commits
```

--------------------------------

### Per Repository Git Configuration

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Configuring Git commit hooks on a per-repository basis.

```bash
git config hooks.commitProvider "ollama"  # or "openai"
git config hooks.providerModel "gpt-4"  # or "llama3.2", etc
git config hooks.commitTemplate "[JIRA-XXX] feat: message"
git config hooks.commitLanguage "es"
git config hooks.ollamaUrl "http://192.168.1.100:11434"  # Custom Ollama server URL
```

--------------------------------

### Limit Scope of Changes

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/SECURITY.md

Command-line interface command to limit the scope of changes when working with sensitive code.

```bash
npx git-rewrite-commits --max-commits 5
```

--------------------------------

### Enable hooks

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Enable specific hooks for enhanced commit workflows.

```bash
# Option A: Enable message preview before commit
git config hooks.preCommitPreview true

# Option B: Enable automatic message generation
git config hooks.prepareCommitMsg true

# Or enable both for the full experience!

# For privacy: use local Ollama instead of remote OpenAI
git config hooks.commitProvider ollama
git config hooks.providerModel llama3.2  # Optional: specify model
```

--------------------------------

### Windows Environment Variables

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Setting environment variables for Git commit hooks on Windows.

```bash
set GIT_COMMIT_PROVIDER=ollama
set GIT_COMMIT_MODEL=gpt-4
set GIT_COMMIT_TEMPLATE=[JIRA-XXX] feat: message
set GIT_COMMIT_LANGUAGE=es
set OLLAMA_URL=http://192.168.1.100:11434  # Custom Ollama server URL
```

--------------------------------

### Configure Commit Template

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Setting a custom commit template for AI-generated messages.

```bash
git config hooks.commitTemplate "[TICKET-XXX] feat: message"
```

--------------------------------

### Team-friendly Hook Configuration

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

A shell script for a Git hook with a template and language setting for team collaboration.

```bash
#!/bin/sh
npx git-rewrite-commits \
  --max-commits 1 \
  --template "[JIRA-XXX] type: message" \
  --language en \
  --skip-backup
```

--------------------------------

### Custom Template Commit Rewriting

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/index.html

This demonstrates using a custom template to rewrite existing commit messages in the repository.

```bash
npx git-rewrite-commits --template "[TECH-123] type: message"
```

--------------------------------

### Custom Quality Scoring

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/API.md

Configures the GitCommitRewriter to only skip commits that meet a minimum quality score, with verbose output enabled to see the scores.

```typescript
// Set higher quality threshold
const rewriter = new GitCommitRewriter({
  minQualityScore: 9,  // Only skip very well-formed commits
  verbose: true        // See quality scores
});
```

--------------------------------

### Alias for Quick Fixes: Shell Alias

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Add shell aliases for common git-rewrite-commits operations.

```bash
# Shell alias
alias fix-last-commit='npx git-rewrite-commits --max-commits 1 --skip-backup'
alias fix-branch='npx git-rewrite-commits --max-commits 20'

# Usage: fix-last-commit
```

--------------------------------

### Team Workflow: Feature Branch Cleanup

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Instructions for cleaning up a feature branch before creating a pull request.

```bash
# Before creating a pull request:

```

--------------------------------

### Minimal Hook Configuration

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

A minimal shell script for a Git hook to fix the last commit using git-rewrite-commits.

```bash
#!/bin/sh
npx git-rewrite-commits --max-commits 1 --skip-backup
```

--------------------------------

### Staged Changes Commit Generation

Source: https://github.com/f/git-rewrite-commits/blob/master/docs/index.html

This sequence shows how to stage changes and use git-rewrite-commits to generate a commit message for them.

```bash
git add src/auth.ts
npx git-rewrite-commits --staged
git commit -m "feat(auth): implement JWT token validation middleware"
```

--------------------------------

### Alias for Quick Fixes: Git Alias

Source: https://github.com/f/git-rewrite-commits/blob/master/README.md

Add a git alias for quickly rewriting a specified number of commits.

```bash
# Git alias
git config --global alias.fix-commits '!npx git-rewrite-commits --max-commits'

# Usage: git fix-commits 3
```

--------------------------------

### Conservative Hook Configuration

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

A shell script for a Git hook that only runs in dry-run mode.

```bash
#!/bin/sh
echo "📝 Suggested improvements:"
npx git-rewrite-commits --max-commits 5 --dry-run
echo "Run 'git-rewrite-commits --max-commits 5' to apply"
```

--------------------------------

### Commit with AI Message

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Performing a commit where the AI message appears automatically in the editor.

```bash
git commit
# Editor opens with:
# [TICKET-123] feat: add user authentication middleware
#
# ✨ AI-generated commit message above
# Feel free to edit as needed before saving
```

--------------------------------

### Disable Hooks Temporarily

Source: https://github.com/f/git-rewrite-commits/blob/master/hooks/README.md

Skipping all Git hooks for a single commit.

```bash
# Skip all hooks for one commit
git commit --no-verify -m "your message"
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.