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

# Installation

> Install OmniCoreAgent and get set up in minutes

# Installation

## Prerequisites

Before installing OmniCoreAgent, ensure you have the following:

<Info>
  **System Requirements:**

  * **Python 3.10+** (Python 3.11+ recommended)
  * **LLM API key** from any supported provider (OpenAI, Anthropic, Google, etc.)
  * **UV package manager** (recommended) or pip
</Info>

### Check Python Version

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
python --version
# Should show Python 3.10.0 or higher
```

### Install UV (Recommended)

UV is faster than pip and handles dependencies more reliably:

<Tabs>
  <Tab title="macOS/Linux">
    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    curl -LsSf https://astral.sh/uv/install.sh | sh
    ```
  </Tab>

  <Tab title="Windows">
    ```powershell theme={"theme":{"light":"github-light","dark":"github-dark"}}
    powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
    ```
  </Tab>

  <Tab title="Python pip">
    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    pip install uv
    ```
  </Tab>
</Tabs>

***

## Installation Methods

<Tabs>
  <Tab title="UV (Recommended)">
    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    uv add omnicoreagent
    ```
  </Tab>

  <Tab title="pip">
    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    pip install omnicoreagent
    ```
  </Tab>

  <Tab title="From Source">
    For development or latest features:

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    git clone https://github.com/omnirexflora-labs/omnicoreagent.git
    cd omnicoreagent
    uv sync
    ```
  </Tab>
</Tabs>

***

## Optional Production Extras

The base install stays focused on the core agent harness. Add heavier production integrations only when your agent uses them:

| Extra       | Installs                                            |
| ----------- | --------------------------------------------------- |
| `redis`     | Redis memory and Redis-backed background task state |
| `postgres`  | SQLAlchemy and PostgreSQL driver                    |
| `mongodb`   | MongoDB async and sync drivers                      |
| `s3`        | AWS S3 and Cloudflare R2 workspace storage          |
| `serve`     | OmniServe REST/SSE API server                       |
| `tokenizer` | tiktoken token counting                             |
| `otel`      | OpenTelemetry OTLP/HTTP trace export                |
| `langsmith` | LangSmith trace export through OTLP                 |
| `opik`      | Comet Opik trace export through OTLP                |
| `all`       | Every optional integration                          |

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
pip install "omnicoreagent[redis]"
pip install "omnicoreagent[serve]"
pip install "omnicoreagent[otel]"
pip install "omnicoreagent[all]"
```

With UV:

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
uv add "omnicoreagent[redis]"
```

***

## Verify Installation

After installation, verify that you can import the package:

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
python -c "import omnicoreagent; print(omnicoreagent.__version__)"
```

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="Python Version Error">
    **Error**: `OmniCoreAgent requires Python 3.10+`

    **Solution**: Upgrade your Python version:

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    # Check available Python versions
    python3.11 --version

    # Use specific Python version with UV
    uv python install 3.11
    uv add omnicoreagent
    ```
  </Accordion>

  <Accordion title="Permission Denied">
    **Error**: Permission denied during installation

    **Solution**: Use user installation:

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    pip install --user omnicoreagent
    ```
  </Accordion>

  <Accordion title="Missing Optional Backend">
    **Error**: `ImportError: Redis memory requires optional dependency 'redis'`

    **Solution**: Install the matching extra:

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    pip install "omnicoreagent[redis]"
    ```

    Use `postgres`, `mongodb`, `s3`, `serve`, `tokenizer`, `otel`, `langsmith`, `opik`, or `all` for other optional integrations.
  </Accordion>

  <Accordion title="Getting Help">
    If you encounter issues:

    1. Search [existing issues](https://github.com/omnirexflora-labs/omnicoreagent/issues)
    2. Create a [new issue](https://github.com/omnirexflora-labs/omnicoreagent/issues/new) with:
       * Your operating system
       * Python version
       * Installation method used
       * Complete error message
  </Accordion>
</AccordionGroup>

***

## Next Steps

<CardGroup cols={3}>
  <Card title="Quick Start" icon="bolt" href="/docs/getting-started/quickstart">
    Build your first agent in under 30 seconds
  </Card>

  <Card title="Core Concepts" icon="brain" href="/docs/core-concepts/overview">
    Learn about memory, events, and tools
  </Card>

  <Card title="Configuration" icon="gear" href="/docs/how-to-guides/configuration">
    Environment variables and agent settings
  </Card>
</CardGroup>