HyperFlowHyperFlow
Home
Guide
Examples
GitHub
Home
Guide
Examples
GitHub
  • Guide

    • Installation
    • Basic Concepts
    • Advanced Concepts & Architectures
    • Limitations
    • Examples
    • Contributing
    • Citation

Installation

Requirements

  • Python 3.11+
  • At least one LLM provider API key (e.g., OPENAI_API_KEY, ANTHROPIC_API_KEY, or GOOGLE_API_KEY).
  • Docker (optional, but recommended if using DockerExecutor for safe agent modifications).

Standard Installation

Install the package directly from PyPI:

pip install hyperflow-ai

Install from Source

For development and contributing, install from the source repository:

git clone https://github.com/lablnet/HyperFlow.git
cd HyperFlow
python3 -m venv .venv
source .venv/bin/activate

pip install -e ".[dev]"

Environment Variables

HyperFlow relies on .env files to configure your workspace. Create an .env file in your root path:

VariableDescription
OPENAI_API_KEYOpenAI API key
ANTHROPIC_API_KEYAnthropic API key
GOOGLE_API_KEYGoogle Gemini API key
OLLAMA_BASE_URLOllama server URL (default: http://localhost:11434)
HYPERFLOW_MODELDefault model for examples (e.g. openai/gpt-4o)
Edit this page
Last Updated: 4/9/26, 2:49 PM
Contributors: Muhammad Umer Farooq
Next
Basic Concepts