Skip to content

Installation

Install readmeai using any of the following package managers:

Install with pip (recommended for most users):

1
pip install -U readmeai

Installation Notes

  1. The -U flag ensures that pip upgrades the package to the latest version.
  2. The core readmeai package includes support for OpenAI and Ollama language models. See the next section for optional dependencies.

Install in an isolated environment with pipx:

1
pipx install readmeai
Why use pipx?

Using pipx allows you to install and run Python command-line applications in isolated environments, which helps prevent dependency conflicts with other Python projects.

For the fastest installation use uv:

1
uv tool install readmeai
Why use uv?

uv is a new-generation Python package installer, built with Rust, that offers significant speed improvements over most Python package managers such as pip. It’s particularly useful for larger projects with many dependencies.

Installing Optional Dependencies

The readmeai package integrates with multiple LLM services through optional dependencies. To use language models offered by Anthropic or Google Gemini, install ReadmeAI’s extra dependencies:

1
pip install "readmeai[anthropic]"

1
pip install "readmeai[google-generativeai]"

1
pip install "readmeai[anthropic,google-generativeai]"

Verify Installation

After installing readmeai, verify the installation with the following command:

1
readmeai --version

Or use the -V flag:

1
readmeai -V

You should see the installed version of readmeai displayed in the output:

1
readmeai version 0.6.0