Skip to main content

Installation

This guide covers the installation process for the PilottAI framework.

Requirements

PilottAI requires the following:
  • Python 3.10 or higher
  • Supported operating systems: Linux, macOS, Windows
  • Optional: An API key for your LLM provider (OpenAI, Anthropic, etc.)

Installation Methods

The simplest way to install PilottAI is using pip:

Installing with Optional Dependencies

PilottAI offers optional dependency sets for various use cases:

Installing from Source

To install the latest development version:

Verifying Installation

Verify your installation with:
This should display the current version of PilottAI.

Installing LLM Provider SDKs

PilottAI supports multiple LLM providers. Depending on which provider you choose, you may need to install additional packages:

Configuration

After installation, you’ll need to configure your LLM provider API keys. There are several ways to do this:

Environment Variables

Set your API key as an environment variable:

Configuration File

You can also create a configuration file ~/.pilottai/config.yaml with your API keys:

Runtime Configuration

Alternatively, you can provide your API key at runtime:

Troubleshooting

Common Issues

ImportError: No module named ‘pilott’
  • Make sure you’ve installed the package correctly
  • Check that your Python environment matches the one where you installed the package
ModuleNotFoundError: No module named ‘openai’
  • Install the required provider SDK: pip install openai
API key error
  • Ensure your API key is correctly set and valid
  • Check that you’re using the right environment variable name

Getting Help

If you encounter any issues during installation:

Next Steps

Now that you have PilottAI installed, continue to the Quick Start guide to create your first multi-agent system.