Prerequisites¶

System Requirements¶

• Python: 3.9+
• Package Manager/Container: pip, pipx, uv, or docker.

Supported Sources¶

The following git hosting services are supported for source code retrieval, along with your local file system:

• GitHub
• GitLab
• Bitbucket
• File System

_{If your Git provider is not listed, open an issue or submit a pull request to add support for additional platforms.}

Supported LLM APIs¶

To enable the full functionality of readmeai, an account and API key are required for one of the following providers:

• OpenAI: Recommended for general use. Requires an OpenAI account and API key.
• Ollama: Free and open-source. No API key required.
• Anthropic: Requires an Anthropic account and API key.
• Google Gemini: Requires a Google Cloud account and API key.
• Offline Mode: Generates a boilerplate README without making API calls.

_{For more information on setting up an API key, refer to the provider's documentation.}