Installation

Complete guide to installing GitGuru on your system.

System Requirements

• Node.js: Version 16.0.0 or higher
• npm: Version 7.0.0 or higher (or yarn 1.22.0+)
• Git: Version 2.20.0 or higher
• Operating System: Windows, macOS, or Linux

Install via npm (Recommended)

The easiest way to install GitGuru is through npm:

npm install -g gitguru

The -g flag installs GitGuru globally, making the gg command available from anywhere in your terminal.

Install via Yarn

If you prefer Yarn:

yarn global add gitguru

Verify Installation

After installation, verify that GitGuru is installed correctly:

gg --version

You should see the version number (currently 0.1.8 ).

gg about

This displays detailed information about your GitGuru installation.

Get Your Gemini API Key

To use GitGuru's AI features, you need a free Gemini API key:

1. Visit Google AI Studio
2. Sign in with your Google account
3. Click "Create API Key"
4. Copy your API key

Configure API Key

Add your API key to GitGuru:

gg addkey YOUR_API_KEY_HERE

Replace YOUR_API_KEY_HERE with your actual API key.

Troubleshooting

Command Not Found

If you get "command not found" after installation:

1. Make sure npm's global bin directory is in your PATH
2. Try closing and reopening your terminal
3. Check npm's global bin location: npm bin -g

Permission Errors

On Unix systems, you might need sudo:

sudo npm install -g gitguru

However, it's better to fix npm permissions properly.

Updating GitGuru

To update to the latest version:

npm update -g gitguru

Uninstall

To uninstall GitGuru:

npm uninstall -g gitguru

Next Steps