Quick Start Guide

Get IOA Core running in 5 minutes with our step-by-step quick start guide.

5 min read Beginner

Prerequisites

Before you begin, ensure you have the following installed:

  • Python 3.8+ - IOA Core requires Python 3.8 or higher
  • pip - Python package installer
  • Git - For cloning the repository (optional)

Installation

Install IOA Core using pip:

pip install ioa-core

Or install from source:

git clone https://github.com/OrchIntel/ioa-core.git
cd ioa-core
pip install -e .

Basic Configuration

Create a basic configuration file:

# config.yaml
governance:
  mode: "advisory"  # advisory, consensus, or enforcement
  rules:
    - name: "data_privacy"
      type: "gdpr"
      enabled: true

memory:
  backend: "sqlite"
  path: "./ioa_memory.db"

audit:
  enabled: true
  level: "info"

Your First Request

Create a simple Python script to test IOA Core:

from ioa_core import IOACore

# Initialize IOA Core
ioa = IOACore(config_path="config.yaml")

# Submit a governance request
request = [object Object]

# Get governance decision
decision = ioa.govern(request)
print("Decision:", decision.action)
print("Reasoning:", decision.reasoning)

Verify Installation

Run the verification command to ensure everything is working:

ioa --version
ioa health-check

You should see output similar to:

IOA Core v2.5.0
Health Check: PASSED
Governance Engine: ACTIVE
Memory Backend: CONNECTED

Next Steps

Now that you have IOA Core running, explore these resources:

Troubleshooting

If you encounter issues: