Installation

Install readmeai using one of the following methods based on your preference.

Pip¶

Pip is the default Python package manager and the simplest way to install readmeai:

pip install readmeai

Pipx¶

To install readmeai in an isolated environment, use pipx:

pipx install readmeai

Why 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.

uv¶

For faster installations, use uv to install readmeai:

uv tool install readmeai

Why 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 from Anthropic or Google Gemini, you'll need to install extra dependencies.

Note

Ensure to use quotes around the package name when installing optional dependencies to avoid shell interpretation issues.

Using Anthropic¶

pip install "readmeai[anthropic]"

Using Google Gemini¶

pip install "readmeai[google-generativeai]"

Install Multiple Dependencies

You can install multiple extra dependencies at once by combining them with commas:

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

Verify Installation¶

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

readmeai --version

# or

readmeai -V

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

readmeai version 0.5.99