Getting Started

OmniFlow is designed to be up and running in under 5 minutes. Follow these steps to initialize your local environment.

1. Installation

Clone the repository to your local machine.


                        git clone https://github.com/omniflow/engine.git

                        cd omniflow-engine

                        pip install -r requirements.txt

2. First Run

Start the core engine. This will spin up the local server and the background agent.


                        python main.py --init

Once running, open your browser at http://localhost:8000 to see the dashboard.

Configuration

All settings are managed in config.json. This file is created automatically on first run.

Adding API Keys

To use external services like OpenAI or Spotify, add your keys to the config file:

{
  "llm_provider": "local",
  "api_keys": {
    "openai": "sk-...",
    "spotify": "client_id_..."
  },
  "modules": {
    "browser_automation": true,
    "hardware_bridge": false
  }
}

Connecting Hardware

OmniFlow can discover ESP32 devices on your local network. Ensure your ESP32 is running the OmniClient Firmware.

Tip: Use the scan_devices() command in the omniflow terminal to find active nodes.