Documentation

Learn the core concepts, architecture, and how to build with CorvinOS.

Core Concepts

๐ŸŽฏ Multi-Tenant Architecture

CorvinOS is built for multiple teams, organizations, and deployment regions. Each tenant has isolated configuration, audit logs, and data storage. Compliance zones enforce regional data residency.

โš™๏ธ Multi-Engine Platform

Swap between Claude, Local Hermes (Ollama), or other AI providers without changing your code. Engines are pluggable via a standardized Protocol. Choose based on latency, cost, and compliance requirements.

๐Ÿ” Structural Compliance

EU AI Act compliance is enforced in code, not policy. Bot disclosure, consent gates, and audit trails are built into the platform architecture. Compliance mechanisms fail-closed and cannot be bypassed.

๐Ÿš€ Agent-to-Agent (A2A) Networks

Connect AI systems across teams with cryptographically signed handoffs. A2A protocol includes HMAC-SHA256 authentication, replay prevention, and data classification filtering.

๐Ÿ“‹ Hash-Chained Audit Trails

Every interaction is recorded in a tamper-proof, SHA256-chained audit log. Logs are encrypted at rest, retained for 7 years, and can be verified cryptographically at any time.

๐Ÿ› ๏ธ Runtime Tool & Skill Generation

Forge Tools are sandboxed, deterministic executables generated at runtime. SkillForge generates LLM behaviors. Both are validated, audited, and can be promoted across task/session/project/user scopes.

Quick Start

1. Clone the Repository

Get the full source code from GitHub. CorvinOS is Apache-2.0 open source โ€” no sign-up required.

git clone https://github.com/CorvinLabs/CorvinOS.git

2. Set Up Environment

Configure voice bridges, compliance zones, and AI engine preferences in your tenant config.

~/.config/corvin-voice/profile.json

3. Deploy an Instance

Launch on your infrastructure. On-premise, EU-cloud, or hybrid deployment options available.

bridge.sh start

Architecture Overview

Adapter & Bridge Layer

HTTP gateway for voice/chat channels. Hot-reload settings, session management, and per-chat permission modes. Handles Discord, WhatsApp, web, and Slack.

Engine Layer (WorkerEngine)

Five pluggable engines: ClaudeCode, Hermes, OpenCode, Codex, and CopilotCLI. All share L10 path-gate, L16 audit, L33 artifact registration.

Forge & SkillForge

Runtime tool/skill generation with MCP server. Sandboxed via bwrap, validated by linter, promoted across scopes with grading gates.

Security Hardening (16+ Layers)

L10 Path Gate, L16 Audit Hardening, L34 Data Classification, L35 Egress Lockdown, L36 GDPR Erasure, L37 Audit Encryption, L38 A2A Protocol.

Compute & Orchestration

Distributed compute layer for training and inference. GPU cluster coordination, workload routing, and cost optimization across regions.

Compliance & Reporting

AI Act evidence generation, GDPR ROPA, audit attestation, and SBOM generation. Automated compliance reporting for regulators.

How Features Work

๐Ÿ”— How the Audit Chain Works

Every event in CorvinOS is recorded to a hash-chained audit log. Each new event includes the SHA256 hash of the previous event, creating an immutable chain. You can verify chain integrity at any time with voice-audit verify. If anyone modifies a historical event, the hash chain breaks and the tampering is detected.

๐Ÿ” How Data Classification Works

CorvinOS classifies data into four levels: PUBLIC (any engine), INTERNAL (EU/local only), CONFIDENTIAL (local only), and SECRET (local, zero egress). Before spawning an engine, the system checks: (1) What data classification is this task? (2) Is this engine allowed in this zone? (3) Does the engine's network egress policy match? If any check fails, the task is rejected with a detailed audit event.

๐Ÿ—‘๏ธ How GDPR Erasure Works

The erasure orchestrator walks through every system layer (user recalls, audit, artifacts, etc.) and deletes records related to a user. It does NOT delete the audit log itselfโ€”instead, it removes the identity mapping, making historical records unlinked to any person. This preserves compliance evidence while respecting the right to deletion.

๐ŸŽค How Voice Bridges Work

Each bridge (Discord, WhatsApp, web) is a stateless HTTP adapter. Messages come in, get converted to CorvinOS format, routed to the configured engine, and converted back to the native format. Bridges support session state, role-based permissions, and hot-reload configuration without restart.

โš™๏ธ How the Engine Layer Works

The WorkerEngine protocol is a contract that every AI engine must implement: spawn(prompt, env=) โ†’ stream. ClaudeCode, Hermes, OpenCode, and others all fulfill this contract. The main loop doesn't care which engine is runningโ€”it just calls the protocol. This allows you to swap engines per-chat or per-organization without code changes.

๐Ÿ› ๏ธ How Forge Tools Generate Safely

Forge doesn't generate arbitrary shell scripts. Instead, users define a schema (inputs, outputs, constraints). Forge generates a Python/bash tool matching that schema, runs it in a minimal bwrap sandbox with no network access, validates outputs against the schema, and audits every execution. The output is deterministic and reproducible.

Ready to dive deeper?

Full source code, detailed docs, examples, and community support on GitHub

View CorvinOS on GitHub โ†’