> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lyzr.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Personal Assistant Quick Start

> Install GitAgent as a global CLI and run it as your daily coding companion via voice, text, or web UI.

## Installation

### Interactive installer (recommended)

```bash theme={null}
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](http://localhost:3333)

### Manual install

```bash theme={null}
npm install -g @open-gitagent/gitagent
mkdir ~/assistant && cd ~/assistant && git init
gitagent --voice --dir .
```

## Setup Modes

| Mode              | Description                                     | Keys                                                        |
| ----------------- | ----------------------------------------------- | ----------------------------------------------------------- |
| Install with LYZR | Easiest — uses Lyzr AI Studio cloud             | `LYZR_API_KEY`                                              |
| Voice + Text      | Real-time voice + text chat                     | `OPENAI_API_KEY` (or `GEMINI_API_KEY` for `--voice gemini`) |
| Text Only         | Terminal REPL, no voice or web UI               | `ANTHROPIC_API_KEY`                                         |
| Advanced Setup    | Choose voice adapter, model, port, integrations | varies                                                      |

<Tip>
  **Auto-scaffold on first run:** `gitagent --dir ~/my-project 'Explain this project'` auto-creates `agent.yaml`, `SOUL.md`, and `memory/` in the target directory.
</Tip>

## Quick Examples

```bash theme={null}
# 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"
```

<CardGroup cols={2}>
  <Card title="CLI Reference" icon="terminal" href="/open-source/gitagent/personal-assistant/cli">
    All flags, REPL commands, and the plugin CLI
  </Card>

  <Card title="Web & Voice" icon="browser" href="/open-source/gitagent/personal-assistant/web-voice">
    Run the full browser interface with real-time voice
  </Card>

  <Card title="Messaging" icon="plug" href="/open-source/gitagent/personal-assistant/messaging">
    Connect Telegram, WhatsApp, and phone
  </Card>

  <Card title="Models & Providers" icon="cpu" href="/open-source/gitagent/configuration/models">
    Configure 12+ LLM providers and custom endpoints
  </Card>
</CardGroup>