Installation

GitScribe can be installed on macOS, Linux, and Windows. Choose your platform below for detailed instructions.

System Requirements

  • Git 2.20 or higher
  • 64-bit operating system
  • 4GB RAM minimum (8GB recommended for local AI models)
  • 500MB free disk space

Installation Methods

🍎 macOS

Via Homebrew (Recommended)

brew tap gitscribe/tap
brew install gitscribe

Via Shell Script

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

Manual Installation

  1. Download the latest release from GitHub Releases
  2. Extract the archive: tar -xzf gitscribe-darwin-amd64.tar.gz
  3. Move to PATH: sudo mv gitscribe /usr/local/bin/
  4. Make executable: chmod +x /usr/local/bin/gitscribe

🐧 Linux

Via Package Managers

Debian/Ubuntu (via APT):

curl -sSL https://gitscri.be/gpg | sudo apt-key add -
echo "deb https://apt.gitscri.be stable main" | sudo tee /etc/apt/sources.list.d/gitscribe.list
sudo apt update
sudo apt install gitscribe

Fedora/RHEL (via YUM):

sudo yum-config-manager --add-repo https://rpm.gitscri.be/gitscribe.repo
sudo yum install gitscribe

Arch Linux (via AUR):

yay -S gitscribe-bin
# or
paru -S gitscribe-bin

Via Shell Script

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

Via Snap

sudo snap install gitscribe

🪟 Windows

Via Chocolatey

choco install gitscribe

Via Scoop

scoop bucket add gitscribe https://github.com/gitscribe/scoop-bucket
scoop install gitscribe

Via PowerShell Script

# Run as Administrator
Set-ExecutionPolicy Bypass -Scope Process -Force
iwr -useb https://gitscri.be/install.ps1 | iex

Manual Installation

  1. Download gitscribe-windows-amd64.exe from GitHub Releases
  2. Rename to gitscribe.exe
  3. Add to your PATH:
    • Create folder: C:\Program Files\GitScribe
    • Move gitscribe.exe to this folder
    • Add folder to PATH environment variable

Docker Installation

Run GitScribe in a container:

# Pull the image
docker pull gitscribe/gitscribe:latest

# Run with your repo mounted
docker run -v $(pwd):/repo gitscribe/gitscribe generate

# Create an alias for convenience
alias gitscribe='docker run -v $(pwd):/repo gitscribe/gitscribe'

Verifying Installation

After installation, verify GitScribe is working:

# Check version
gitscribe --version

# Run health check
gitscribe doctor

# View help
gitscribe --help

Shell Completions

Enable tab completions for your shell:

Bash

gitscribe completions bash > ~/.gitscribe-completion.bash
echo "source ~/.gitscribe-completion.bash" >> ~/.bashrc

Zsh

gitscribe completions zsh > ~/.gitscribe-completion.zsh
echo "source ~/.gitscribe-completion.zsh" >> ~/.zshrc

Fish

gitscribe completions fish > ~/.config/fish/completions/gitscribe.fish

PowerShell

gitscribe completions powershell | Out-String | Invoke-Expression

Updating GitScribe

Keep GitScribe up to date:

# Built-in updater
gitscribe update

# Or use your package manager
brew upgrade gitscribe
apt update && apt upgrade gitscribe
choco upgrade gitscribe

Uninstalling

To remove GitScribe:

Package Manager

# Homebrew
brew uninstall gitscribe

# APT
sudo apt remove gitscribe

# Chocolatey
choco uninstall gitscribe

Manual Removal

# Remove binary
sudo rm /usr/local/bin/gitscribe

# Remove config
rm -rf ~/.gitscribe

# Remove completions
rm ~/.gitscribe-completion.*

Troubleshooting Installation

Common issues and solutions:

Permission Denied

# Fix with sudo
sudo curl -sSL https://gitscri.be/install | sudo sh

Command Not Found

Add GitScribe to your PATH:

echo 'export PATH="$PATH:/usr/local/bin"' >> ~/.bashrc
source ~/.bashrc

SSL Certificate Error

# Bypass SSL (not recommended for production)
curl -sSLk https://gitscri.be/install | sh

Still having issues? Check our troubleshooting guide or join our Discord for help.