Getting Started

  • Prerequisites: Docker Engine ≥20.10, Docker Compose ≥1.29, Kubernetes (optional), Python ≥3.9, Node.js ≥16, and a Unix‑based OS or WSL2 for Windows.

  • Installation: Clone the Orient AI repository and run:

    git clone https://github.com/orient-ai/platform.git
    cd platform
    ./scripts/install.sh

    This script installs required dependencies, provisions local Docker containers for core services (Kafka, TimescaleDB, MinIO), and initializes the environment variables.

  • First Agent Deployment: Use the example pipeline:

    cd examples/basic-momentum
    orient-cli deploy --config config.yml

    Verify agent status with orient-cli status or via the Web Dashboard.

Last updated