Skip to main content

Installation

bash <(curl -fsSL "https://raw.githubusercontent.com/open-gitagent/gitagent/main/install.sh?$(date +%s)")
Installs globally via npm, walks through API key setup, launches web UI at http://localhost:3333

Manual install

npm install -g @open-gitagent/gitagent
mkdir ~/assistant && cd ~/assistant && git init
gitagent --voice --dir .

Setup Modes

ModeDescriptionKeys
Install with LYZREasiest — uses Lyzr AI Studio cloudLYZR_API_KEY
Voice + TextReal-time voice + text chatOPENAI_API_KEY (or GEMINI_API_KEY for --voice gemini)
Text OnlyTerminal REPL, no voice or web UIANTHROPIC_API_KEY
Advanced SetupChoose voice adapter, model, port, integrationsvaries
Auto-scaffold on first run: gitagent --dir ~/my-project 'Explain this project' auto-creates agent.yaml, SOUL.md, and memory/ in the target directory.

Quick Examples

# Single-shot query
gitagent --dir ~/my-project "Build a REST API for user management"

# With voice UI
gitagent --voice --dir ~/assistant

# Local repo mode — clone, fix, commit to session branch
gitagent --repo https://github.com/org/repo --pat ghp_xxx "Fix the login bug"

CLI Reference

All flags, REPL commands, and the plugin CLI

Web & Voice

Run the full browser interface with real-time voice

Messaging

Connect Telegram, WhatsApp, and phone

Models & Providers

Configure 12+ LLM providers and custom endpoints