The OSIRIS JSON Toolbox

it provides the canonical validation engine, command-line interface, and tooling SDK for the OSIRIS JSON ecosystem.

It validates OSIRIS JSON documents generated by the OSIRIS JSON producer against the OSIRIS JSON specification and core schema, verifies their internal consistency, and produces structured diagnostics results.

Architecture workflow

This repository implements the OSIRIS JSON Toolbox layer within the wider OSIRIS ecosystem.

flowchart TD 
    subgraph VP ["Vendor / Platform"]
        A["Hyperscalers, Cloud & Hosting Providers"]
        B["On-Premises<br/>IT and OT"]
    end
    
    subgraph SP ["The OSIRIS JSON Specification"]
        S["The authoritative<br/>source of truth for the<br/>specification and core schema"]
    end
    
    subgraph PR ["The OSIRIS JSON Producers"]
        P["Discover, Normalize, Redact, Emit"]
        J["OSIRIS JSON Document<br/>Portable point-in-time infrastructure snapshot"]
    end
    
    subgraph VA ["The OSIRIS JSON Toolbox"]
        V["Validation toolbox<br/>Three-level validation"]
    end
    
    subgraph OC ["The OSIRIS JSON Consumers"]
        C["Consumers under development<br/>Read OSIRIS JSON documents"]
        AD["Architecture documentation reports"]
        AU["Audit reports"]
        DF["Snapshot diff view"]
        TP["Automatic topology<br/>generation and updates"]
    end
    
    subgraph UC ["Under Your Full Control"]
        U["One OSIRIS JSON file<br/>Multiple use cases"]
        M["CMDB / IPAM / DCIM workflows"]
        AI["AI platforms, agents<br/>and MCP servers"]
        X["Custom analytics<br/>and third-party tools"]
    end
    
    A -->|"Discovered by"| P
    B -->|"Discovered by"| P

    S -. "Defines the format" .-> J
    S -. "Guides implementation" .-> P

    P -->|"Generates"| J

    J -->|"Validated by"| V

    J -->|"Consumed by"| C
    C -->|"Generates"| AD
    C -->|"Generates"| AU
    C -->|"Generates"| DF
    C -->|"Generates"| TP

    J --> U
    U --> M
    U --> AI
    U --> X
    
    style VP fill:transparent,stroke:#555,stroke-width:1px,color:inherit
    style SP fill:transparent,stroke:#555,stroke-width:1px,color:inherit
    style PR fill:transparent,stroke:#555,stroke-width:1px,color:inherit
    style VA fill:transparent,stroke:#4F7FE7,stroke-width:2px,color:inherit
    style OC fill:transparent,stroke:#555,stroke-width:1px,color:inherit
    style UC fill:transparent,stroke:#555,stroke-width:1px,color:inherit

Loading

Installation

See the official guidelines available on docs.osirisjson.org/validate/toolbox-cli

Documentation and contribution

• OSIRIS JSON Validation levels
• Community and Contribution Guidelines