Quickstart

Get GitScribe up and running in just 5 minutes. This guide will walk you through installation, setup, and your first AI-powered commit message.

Prerequisites

• Git installed on your system
• A terminal or command prompt
• An active internet connection (for installation only)

1. Install GitScribe

Run the appropriate command for your operating system:

macOS/Linux

# Using curl
curl -sSL https://gitscri.be/install | sh

# Or using wget
wget -qO- https://gitscri.be/install | sh

Windows

# Run in PowerShell as Administrator
iwr -useb https://gitscri.be/install.ps1 | iex

The installer will:

• Download the latest GitScribe binary
• Install it to your PATH
• Set up shell completions (optional)
• Verify the installation

2. Initialize GitScribe in Your Repository

Navigate to your Git repository and run:

cd your-project
gitscribe init

This creates a .gitscribe.toml configuration file with sensible defaults. You'll be asked a few questions:

• Commit style: Conventional Commits, Angular, or Custom
• AI model preference: Local (free) or Cloud (Pro)
• Language: For commit messages (default: English)

3. Make Your First AI Commit

Make some changes to your code, then:

# Stage your changes as usual
git add .

# Instead of 'git commit -m', just run:
git commit

# GitScribe automatically generates the message!

GitScribe will:

1. Analyze your staged changes
2. Generate a meaningful commit message
3. Open your editor with the message pre-filled
4. Let you review and edit before committing

Example Output

Here's what you'll see:

$ git add src/auth.js
$ git commit

✨ GitScribe is analyzing your changes...

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

- Add validateToken function with expiry checking
- Include role-based access control
- Add comprehensive error handling for invalid tokens
────────────────────────────────

Press ENTER to accept, 'e' to edit, or 'r' to regenerate:

Next Steps

• Configure GitScribe for your team's conventions
• Set up IDE integrations for a smoother workflow
• Upgrade to Pro for advanced AI models and team features

Pro Tip: Run gitscribe config --global to set preferences that apply to all your repositories!

Common Commands

# Generate commit message for staged changes
gitscribe generate

# Configure GitScribe
gitscribe config

# View current settings
gitscribe status

# Update GitScribe
gitscribe update

# Get help
gitscribe --help