Installation

This guide covers how to install CortexFlow.

Prerequisites

Python 3.8 or higher
Ollama (for local LLM integration) or Vertex AI credentials (for cloud-based inference)

Basic Installation

You can install CortexFlow using pip:

pip install cortexflow

Installation with Optional Dependencies

For graph-based knowledge features:

pip install "cortexflow[graph]"

For Vertex AI backend support:

pip install "cortexflow[vertex]"

Note

The vertex extra installs google-cloud-aiplatform and google-genai for using Google Vertex AI models (e.g. Gemini) as an alternative to local Ollama inference. See the Configuration guide for how to configure Vertex AI as your LLM backend.

For the full package with all dependencies:

pip install "cortexflow[all]"

Development Installation

For development, you can install CortexFlow with development dependencies:

git clone https://github.com/cortexflow/cortexflow.git
cd cortexflow
pip install -e ".[dev]"

Verifying Installation

You can verify that CortexFlow is installed correctly by running:

import cortexflow
print(cortexflow.__version__)