Skip to content
PlanAI

Installation

PlanAI can be installed using pip or poetry. Choose the method that best fits your project setup.

Requirements

Section titled “Requirements”
  • Python 3.10 or higher
  • pip or Poetry package manager

Install with pip

Section titled “Install with pip”

The simplest way to install PlanAI is using pip:

Terminal window
pip install planai

Install with Poetry

Section titled “Install with Poetry”

If you’re using Poetry for dependency management:

Terminal window
poetry add planai

Development Installation

Section titled “Development Installation”

To contribute to PlanAI or work with the latest development version:

  1. Clone the repository:
Terminal window
git clone https://github.com/provos/planai.git
cd planai
  1. Install dependencies using Poetry:
Terminal window
poetry install
  1. Activate the virtual environment:
Terminal window
poetry shell

Verify Installation

Section titled “Verify Installation”

To verify that PlanAI is installed correctly, you can run:

Terminal window
python -c "import planai; print(planai.Task)"

Or check the CLI:

Terminal window
planai --help

Optional Dependencies

Section titled “Optional Dependencies”

PlanAI has several optional dependencies for specific features:

LLM Providers

Section titled “LLM Providers”

To use specific LLM providers, you may need to install additional packages:

  • OpenAI: Included by default via llm-interface
  • Ollama: Requires Ollama to be installed and running locally
  • Other providers: Check the llm-interface documentation for supported providers

Web Monitoring Dashboard

Section titled “Web Monitoring Dashboard”

The monitoring dashboard requires Flask, which is included in the default installation.

Next Steps

Section titled “Next Steps”

Now that you have PlanAI installed, you’re ready to: