quickstart

Quick Start

Get up and running with IOA Core in minutes.

Prerequisites

• Python 3.10 or higher
• pip or poetry
• (Optional) LLM provider API keys for live testing

Installation

Quick Install (Recommended)

pip install ioa-core

From Source

git clone https://github.com/orchintel/ioa-core.git
cd ioa-core
pip install -e ".[dev]"

System Health Check

Verify your environment:

python examples/30_doctor/doctor_check.py

Expected output:

{
  "python_version_ok": true,
  "python_version": "3.10.0",
  "overall_health": "healthy"
}

Bootstrap a Project

Create a new IOA project:

python examples/00_bootstrap/boot_project.py my-ai-system

This creates:

• my-ai-system/ioa.yaml - Configuration
• my-ai-system/README.md - Project docs

Run Your First Workflow

Execute a governed workflow:

python examples/10_workflows/run_workflow.py

Output shows:

• Task executed
• Governance policy applied
• Audit evidence ID
• System Laws enforced

Test Provider Connectivity

Check provider status:

# Mock provider (no API key needed)
IOA_PROVIDER=mock python examples/40_providers/provider_smoketest.py

# Real provider (requires API key)
IOA_LIVE=1 IOA_PROVIDER=openai python examples/40_providers/provider_smoketest.py

Multi-Agent Quorum

Run vendor-neutral roundtable:

python examples/20_roundtable/roundtable_quorum.py "Analyze this code for security issues (ok)"

Demonstrates:

• 3-agent quorum voting
• 2-of-3 approval threshold
• Vendor-neutral consensus

Interactive Colab Demos

Aletheia Runtime Demo (Public - No API Keys Required)

• Colab:
• Description: Educational simulation of IOA Core with Aletheia Framework v2.0 integration
• Features: 6-facet governance scoring, policy enforcement simulation, evidence bundle generation

Cloud API Demo (Internal - Requires API Keys & Backend)

• Colab:
• Description: Live IOA Cloud API integration with real governance checks
• Features: Actual API calls, real evidence bundles, production-ready examples

Next Steps

• Getting Started Guide - Comprehensive setup and configuration
• System Laws - Understand IOA's core principles
• Cartridges - Compliance modules
• CLI Reference - Advanced usage

Getting Help

• Check python examples/30_doctor/doctor_check.py for environment issues
• Visit GitHub Issues for bug reports
• Join Discord for community support
• Read the Full Documentation for detailed guides