> For the complete documentation index, see [llms.txt](https://samrel-ai.gitbook.io/samrel-ai-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://samrel-ai.gitbook.io/samrel-ai-documentation/getting-started/installation.md).

# Installation

**Installation**

We provide several ways to install Samrel AI. Choose the one that best suits your needs.

**Supported Systems and Versions**

System Version

Python Version

Supported

macOS 13.x

Python 3.9+

Yes

Windows 11

Python 3.9+

Yes

Ubuntu 22.04

Python 3.9+

Yes

Ensure that Python 3.9+ is installed on your system:

Copy

Copy

```
python3 --version
```

**Install Stable Version**

Recommended for most users:

Copy

Copy

```
pip install samrelai
```

**Install Submodules**

* **RAG**: `pip install '`samrelai`[rag]'`
* **OCR**: `pip install '`samrelai`[ocr]'`
* **Search-DDG**: `pip install '`samrelai`[search-ddg]'`
* **Search-Google**: `pip install '`samrelai`[search-google]'`
* **Selenium**: `pip install '`samrelai`[selenium]'`

**Install Latest Development Version**

For the newest features:

Copy

Copy

```
pip install git+https://github.com/your-org/samrelai.git
```

**Install in Development Mode**

For developers and researchers:

Copy

Copy

```
git clone https://github.com/your-org/samrelai.git
cd ./samrelai
pip install -e .
```

Install submodules:

Copy

Copy

```
pip install -e .[rag]
```

**Install with Docker**

**Use Default Samrel AI Image**:

Copy

Copy

```
# Step 1: Pull the image and prepare configuration
docker pull samrelai/samrelai:latest
mkdir -p /opt/samrelai/{config,workspace}
docker run --rm samrelai/samrelai:latest cat /app/samrelai/config/config.yaml > /opt/samrelai/config/config.yaml

# Step 2: Run a demo
docker run --rm \
    --privileged \
    -v /opt/samrelai/config/config.yaml:/app/samrelai/config/config.yaml \
    -v /opt/samrelai/workspace:/app/samrelai/workspace \
    samrelai/samrelai:latest \
    samrelai"Write a cli snake game"
```

**Build Your Own Image**:

Copy

Copy

```
git clone https://github.com/your-org/samrelai.git
cd samrelai&& docker build -t samrelai:custom .
```

**Installation for Full Features**

To generate diagrams like flowcharts and system designs:

**Mermaid with Node.js**:

Copy

Copy

```
npm install -g @mermaid-js/mermaid-cli
```

**Playwright**:

Copy

Copy

```
pip install playwright
playwright install --with-deps chromium
```