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

# Local Development Setup

> Set up for local development. Clone the repo, install dependencies, and run tests to start contributing.

## Getting Started

<Steps>
  <Step title="Fork the repo">
    Fork [AugentDevs/Augent](https://github.com/AugentDevs/Augent) on GitHub.
  </Step>

  <Step title="Clone your fork">
    ```bash theme={null}
    git clone https://github.com/YOUR_USERNAME/Augent.git
    cd Augent
    ```
  </Step>

  <Step title="Create a branch">
    ```bash theme={null}
    git checkout -b my-feature
    ```

    Use a descriptive branch name: `fix-memory-bug`, `add-wav-support`, `docs-typo`, etc.
  </Step>

  <Step title="Install in development mode">
    ```bash theme={null}
    pip install -e ".[dev,all]"
    ```

    This installs Augent with all optional dependencies (speakers, semantic search, TTS, web UI) plus dev tools (pytest, black, ruff) in editable mode.
  </Step>

  <Step title="Verify everything works">
    ```bash theme={null}
    pytest tests/ -v
    ```
  </Step>
</Steps>

***

## Requirements

* Python 3.10+
* ffmpeg (for audio processing)
* aria2 (for fast downloads)
* yt-dlp (for audio downloading)

***

## Run tests

```bash theme={null}
pytest tests/ -v --tb=short
```

Tests run on Python 3.10, 3.11, 3.12, and 3.13 via CI.

## Lint & format

```bash theme={null}
# Check
ruff check .
black --check .

# Auto-fix
ruff check . --fix
black .
```

## Run the MCP server locally

```bash theme={null}
augent-mcp
```

## Config overrides

User config lives at `~/.augent/config.yaml` and is loaded by `augent/config.py`. During development, create this file to test config overrides (model size, output directories, disabled tools). See [Configuration](/guides/configuration).