Quick Start
# One-line install & launch
curl -fsSL https://raw.githubusercontent.com/open-gitagent/gitclaw/main/install.sh | bash
This installs GitClaw globally via npm, walks you through setup (API keys, voice adapter, model), and launches the web UI at http://localhost:3333.
Installation
Requirements
- Node.js 20+ (required by WhatsApp dependency)
- Git (for memory commits and session branches)
- npm (included with Node.js)
Install Methods
Interactive installer (recommended):
curl -fsSL https://raw.githubusercontent.com/open-gitagent/gitclaw/main/install.sh | bash
Manual install:
npm install -g gitclaw
mkdir ~/assistant && cd ~/assistant && git init
gitclaw --voice --dir .
Setup Modes
The installer offers four options:
| Mode | Description | Keys Required |
|---|---|---|
| Install with LYZR | Easiest — uses Lyzr AI Studio cloud | LYZR_API_KEY |
| Voice + Text | Real-time voice + text chat | OPENAI_API_KEY + ANTHROPIC_API_KEY |
| Text Only | Browser text chat, no voice | ANTHROPIC_API_KEY |
| Advanced Setup | Choose voice adapter, model, port, integrations | varies |
Updating
# The installer auto-detects existing installations and offers to update
curl -fsSL https://raw.githubusercontent.com/open-gitagent/gitclaw/main/install.sh | bash
# Or manually
npm update -g gitclaw
CLI Reference
Basic Usage
# Launch voice/web UI
gitclaw --voice --dir ~/assistant
# Single-shot query (no REPL)
gitclaw --dir ~/assistant "Build a REST API for user management"
# Interactive REPL
gitclaw --dir ~/assistant
# With specific model
gitclaw --model anthropic:claude-opus-4-6 --voice --dir ~/assistant
Flags
| Flag | Short | Description | Default |
|---|---|---|---|
--model | -m | Model to use (provider:model-id) | from agent.yaml |
--dir | -d | Agent directory | current directory |
--prompt | -p | Single-shot prompt | — |
--env | -e | Environment config (loads config/<env>.yaml) | default |
--voice | -v | Enable voice mode (optionally: openai or gemini) | — |
--sandbox | -s | Run in E2B sandbox VM | false |
--sandbox-repo | — | Repository URL for sandbox | — |
--sandbox-token | — | E2B API token | E2B_API_KEY env |
--repo | -r | Clone and work on remote repository | — |
--pat | — | GitHub/GitLab personal access token | GITHUB_TOKEN env |
--session | — | Git branch name for session isolation | auto-generated |
REPL Commands
| Command | Description |
|---|---|
/quit or /exit | Exit the session |
/memory | View the memory file |
/skills | List installed skills |
/tasks | Show active learning tasks |
/learned | List learned skills with confidence scores |
/plugins | List loaded plugins |
/skill:name args | Invoke a specific skill |
Plugin CLI
gitclaw plugin install https://github.com/user/plugin-repo
gitclaw plugin install ./local/path --name my-plugin --force
gitclaw plugin list --dir ~/assistant
gitclaw plugin enable my-plugin --dir ~/assistant
gitclaw plugin disable my-plugin --dir ~/assistant
gitclaw plugin remove my-plugin --dir ~/assistant
gitclaw plugin init my-plugin --dir ~/assistant