HyperFlowHyperFlow
Home
Guide
Examples
GitHub
Home
Guide
Examples
GitHub
  • Guide

    • Installation
    • Basic concepts
    • Advanced concepts and architecture
    • Limitations
    • Examples
    • Contributing
    • Citation

Installation

Requirements

  • PHP 8.1+
  • Composer
  • At least one LLM provider API key (e.g., OPENAI_API_KEY).
  • Docker (optional, but recommended if using DockerExecutor for safe agent modifications).

Standard Installation

Install the package via Composer:

composer require lablnet/hyperflow-php

Install from Source

For development and contributing, install from the source repository:

git clone https://github.com/lablnet/hyperflow-php.git
cd hyperflow-php

composer install

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/29/26, 5:05 AM
Contributors: Muhammad Umer Farooq
Next
Basic concepts