Quick Start

Prerequisites

• Option 1: Docker (Recommended):

  • Docker (v20.10+)

  • Docker Compose (v2.0+, included with Docker Desktop)

• Option 2: Manual Installation:

  • Node.js (v18+)

  • npm (v7+)

  • Python (v3.8+, optional for Python wrapper)

Ensure node and python are in your system's PATH.Installation and SetupOption 1: Quick Start with Docker (Recommended)bash

# Clone the repository
git clone https://github.com/Blockchain1Royale/OMNIFLUX-ALPHA.git
cd OMNIFLUX-ALPHA

# Run OmniFlux using the quick start script
chmod +x run-omniflux.sh
./run-omniflux.sh

This will build and start OmniFlux in Docker containers, launching the CLI automatically.Option 2: Manual Installation

1. Clone the Repository:bash

   git clone https://github.com/Blockchain1Royale/OMNIFLUX-ALPHA.git
   cd OMNIFLUX-ALPHA

2. Install Node.js Dependencies:bash

   npm install

3. Install Python Dependencies (Optional):bash

   cd packages/python-wrapper
   pip install -e .
   cd ../..

4. Set Up Environment Variables:bash

   cp .env.example .env
   nano .env  # Add your Solana RPC URL, API keys, etc.

   Required keys:

   • SOLANA_RPC_URL: For Solana blockchain interaction (e.g., from QuickNode or Alchemy).

   • OPENAI_API_KEY: For OpenAI integration (optional).

   • ARWEAVE_WALLET_FILE: Path to your Arweave wallet file (optional).

Running OmniFluxOption 1: Using Docker (Recommended)bash

# Quick start with a single command
./run-omniflux.sh

Option 2: Manual Setup

1. Run the Server:bash

   node server.js

2. Run the Interactive CLI:bash

   node packages/cli/interactive.cjs

Option 3: Using the Python Wrapperpython

import asyncio
from omniflux import OmniFlux

async def main():
    client = OmniFlux(host="localhost", port=8052)
    await client.connect()
    health = await client.check_health()
    print(f"OmniFlux Health: {health['status']}")
    await client.disconnect()

asyncio.run(main())