Omni Scanner

🔱 Omni — The All-Seeing Eye

The Federation Governance Tricorder — A modular, extensible observation engine that scans, maps, and guards codebases at galactic scale.

"Never trust documentation, trust reality." — ACE

Omni is a Python-powered passive observation platform that discovers the truth about your code. It doesn't modify files or break builds — it sees, maps, and reports. Think of it as a tricorder for your codebase: point it at any directory and it reveals structure, dependencies, health, drift, and compliance in seconds.

✨ At a Glance

🚀 Quick Start

New Here? Check out the Beginner's Guide: Zero to Hero for a step-by-step setup tutorial.

Install

# Recommended: Install from PyPI
pip install omni-governance

# Or install from source:
# pip install -e .

Your First Scan

# Scan the current directory with all static scanners
omni scan .

# Run a specific scanner
omni scan . --scanner surfaces

# See what Omni knows about itself
omni introspect

Explore the Ecosystem

# Map your entire project constellation
omni map

# Check governance compliance
omni gate .

# Generate a full report
omni report . --format markdown

🏗️ Architecture — The Trinity

Omni follows the Trinity Architecture — three layers with strict separation of concerns:

                    ┌──────────────────────────┐
                    │        CLI (cli.py)       │  ← User interface
                    │     14 verbs, 1 brain     │
                    └────────────┬─────────────┘
                                 │
              ┌──────────────────┼──────────────────┐
              │                  │                  │
    ┌─────────▼──────┐  ┌───────▼────────┐  ┌──────▼───────┐
    │  🧠 CORE       │  │  🏛️ PILLARS    │  │  📚 LIB      │
    │  Identity      │  │  Cartography   │  │  I/O, Render │
    │  Registry      │  │  Intel         │  │  Reporting   │
    │  Gate          │  │  Gatekeeper    │  │  Tree, TAP   │
    │  Paths         │  │  Registry      │  │  Requirements│
    └─────────┬──────┘  └───────┬────────┘  └──────────────┘
              │                 │
    ┌─────────▼─────────────────▼──────────────────────────┐
    │              🔍 SCANNERS (55 Instruments)            │
    │   12 categories • Dynamic plugin loading             │
    │   Each scanner: scan(target: Path) → dict            │
    └──────────────────────────────────────────────────────┘
              │
    ┌─────────▼──────┐
    │  🔧 BUILDERS   │  ← The only layer that writes
    │  Registry Gen  │
    │  Report Gen    │
    └────────────────┘

Read-Only Guarantee: Scanners never modify source files. Only Builders write, and only to designated artifact directories.

For the full architectural deep-dive, see ARCHITECTURE.md.

🔍 Scanner Categories

Omni's 55 scanners are organized into 12 categories. Each scanner implements the universal scan(target: Path) → dict contract and is auto-discovered via SCANNER_MANIFEST.yaml files.

Open Source Scanners (Included in Build)

Federation-Exclusive Scanners (Not in Open Source Build)

These scanners require the Federation Heart backend and are part of the proprietary governance layer. They appear in omni introspect when the Heart is available but are not distributed with the open-source release.

Each category has its own README with detailed scanner documentation. See the Scanner Architecture Guide for the complete reference.

🏛️ The Four Pillars

Pillars are orchestration subsystems that coordinate multiple scanners and produce higher-level intelligence:

See Pillars Architecture for the deep dive.

⚡ CLI Command Reference

🔌 Federation Mode vs. Standalone

Omni operates in two modes, transparently:

Standalone Mode (Default)

No external dependencies. Configuration from omni.yml and environment variables. All open-source scanners work perfectly. Ideal for individual developers and open-source projects.

Federation Mode (Optional)

When federation_heart is installed, Omni gains:

• CartographyPillar — Canonical path resolution across the entire Federation
• Constitution — Governance rule enforcement from a central authority
• CMP Integration — Project identity resolution against the Canonical Master Project database
• Runtime Health — Live status of Federation services, stations, and tunnels

The integration is handled by a single shim (omni/config/settings.py) that bridges to the Heart when available and falls back gracefully when it's not.

🧠 MCP Server

Omni includes a Model Context Protocol (MCP) server that exposes all 55 scanners as AI-callable tools. Any MCP-compatible AI assistant can invoke Omni's scanners programmatically.

Quick Start (npx)

The absolute easiest way to use the MCP Server is via npx (requires Node.js):

npx -y @modelcontextprotocol/inspector mcp-server-omni-governance

Run from Source

# The MCP server auto-discovers all registered scanners
python -m mcp_server.omni_mcp_server

See MCP Server Documentation for setup and configuration.

📁 Project Structure

omni/
├── README.md              ← You are here
├── ARCHITECTURE.md        ← Full architectural deep-dive
├── CONTRIBUTING.md        ← How to add scanners and contribute
├── CHANGELOG.md           ← Version history
├── ROADMAP.md             ← Future plans
├── pyproject.toml         ← Package definition
├── omni/
│   ├── cli.py             ← CLI entry point (14 commands)
│   ├── core/              ← Brain — identity, registry, gate, paths
│   ├── config/            ← Configuration & Federation Heart bridge
│   ├── scanners/          ← 55 scanners across 12 categories
│   ├── pillars/           ← 4 orchestration subsystems
│   ├── lib/               ← Shared utilities (I/O, rendering, reporting)
│   ├── builders/          ← Registry and report generators
│   ├── scaffold/          ← Project templates
│   └── templates/         ← Jinja2 report templates
├── mcp_server/            ← MCP server exposing scanners as AI tools
├── scripts/               ← Operational scripts
├── tests/                 ← Test suite (pytest)
├── docs/                  ← Historical docs and plans
└── contracts/             ← Crown Contracts (C-TOOLS-OMNI-*)

🔧 Configuration

Omni follows a strict configuration hierarchy (highest priority wins):

1. CLI flags (e.g., --scanner surfaces)
2. Environment variables (e.g., OMNI_ROOT)
3. omni.yml (project-level configuration)
4. Built-in defaults (sensible fallbacks)

Key environment variables:

See Configuration Guide for full details.

🧪 Testing

# Run all tests
pytest tests/ -v

# With coverage
pytest tests/ --cov=omni --cov-report=html

See Test Suite Documentation for fixtures, standards, and CI setup.

🤝 Contributing

We welcome new scanners, pillars, and improvements. The scanner plugin system makes it straightforward to add new observation capabilities:

1. Create a scanner file with a scan(target: Path) → dict function
2. Register it in the category's SCANNER_MANIFEST.yaml
3. Add tests and documentation

See CONTRIBUTING.md for the full guide.

📜 Requirements

• Python: 3.8+
• Dependencies: pyyaml, pydantic (core); federation_heart (optional, for Federation mode)
• OS: Windows, macOS, Linux

📋 License

Open source. See LICENSE for details.

The All-Seeing Eye observes. The Code writes the Code.
Omni v0.7.0 — Pantheon LadderWorks