Skip to main content

​
Installation

This guide walks you through installing BindAI and preparing your development environment.

​
Requirements

Before installing BindAI, make sure you have:
  • Python 3.11 or newer
  • pip
  • Git (recommended)
You can verify your Python version:

​
Clone the Repository

Clone the BindAI repository.
Enter the project directory.

​
Create a Virtual Environment

It is recommended to isolate your Python dependencies. Windows
Linux / macOS
After activation, your terminal should display the virtual environment name. Example:

​
Install BindAI

Install all local packages in editable mode.
If you’re developing the framework itself, editable mode ensures that changes to the source code are immediately available without reinstalling.

​
Verify the Installation

You can verify the installation by importing BindAI.
If no errors occur, the installation was successful. Exit Python.

​
Configure Environment Variables

Many AI providers require an API key. Create a .env file in your project root. Example:
BindAI automatically loads environment variables when supported providers are used.

​
Install Provider Packages

BindAI separates model providers into independent packages. For example: OpenAI
Anthropic
Google Gemini
Ollama
You only need to install the providers you intend to use.

​
Install Optional Packages

Some BindAI features require optional packages. Examples include:
  • Vector databases
  • Memory providers
  • Document loaders
  • Embedding providers
Install only the packages needed for your application.

​
Running an Example

The repository includes example templates. Run one of the examples:
If everything is configured correctly, the agent should execute and return a response from the configured AI provider.

​
Common Issues

​
ModuleNotFoundError

Ensure that the virtual environment is activated. Reinstall the project if necessary.

​
Missing API Key

If the provider reports an authentication error, verify that the required environment variable exists. Example:

​
Python Version

BindAI targets modern Python versions. Verify your installation: