installation.md

Installation

ReadmeAI is available on PyPI as readmeai and can be installed as follows:

{ width="2%" } Pip

Install with pip (recommended for most users):

❯ pip install -U readmeai

{ width="2%" } Pipx

With pipx, readmeai will be installed in an isolated environment:

❯ pipx install readmeai

{ width="2%" } Uv

The fastest way to install readmeai is with [uv][uv-link]:

❯ uv tool install readmeai

{ width="2%" } Docker

To run readmeai in a containerized environment, pull the latest image from [Docker Hub][dockerhub-link]:

❯ docker pull zeroxeli/readme-ai:latest

{ width="2%" } From source

Click to build readmeai from source

1. Clone the repository:

   ❯ git clone https://github.com/eli64s/readme-ai

2. Navigate to the project directory:

   ❯ cd readme-ai

3. Install dependencies:

   ❯ pip install -r setup/requirements.txt

Alternatively, use the [setup script][setup-script] to install dependencies:

{ width="2%" } Bash

1. Run the setup script:

   ❯ bash setup/setup.sh

Or, use poetry to build and install project dependencies:

{ width="2%" } Poetry

1. Install dependencies with poetry:

   ❯ poetry install

---