Getting started overview
There are three paths into OSIRIS JSON, depending on what you need to do. OSIRIS is designed so these roles can move independently: producers create a point-in-time snapshot, validators verify it, and consumers review and trust it without needing to develop specific integrations or understand every vendor protocols and architecture behind it.
Choose your path
Developer path
For those who want to build on OSIRIS JSON: producer, CLI, editor/IDE integration, and teams integrating OSIRIS JSON into CI, CMDB, or diagram and documentation pipelines.
This path covers: project boundaries, single-source-of-truth rule, canonical validation flow, producer contract (discovery, normalization, redaction, emission), deterministic IDs, stable metadata, and golden-file testing patterns.
Validation path
For those who mainly want to consume, review, and trust OSIRIS JSON documents: solution architects, auditors, compliance teams, infrastructure documentation teams, enterprise reviewers, and pre-sales/consulting teams.
arrow_forward Validation guideThe validation guide explains how the npm CLI package is expected to be installed, how to validate files and directories, what basic, default, and strict mean, and which exit codes to expect.
The best starting point for consumers is not producer development it is validation.
Producer path
For solution architects, auditors, and infrastructure teams who want to generate OSIRIS documents from their live platforms using vendor-specific producers.
router Network vendors
Cisco
APIC, NX-OS, IOS
Arista
EOS
Nokia
SR Linux, EDA
HPE
Apstra
Juniper
Junos
cloud Hyperscalers
Run a producer against your platform, validate the output, and use it as a reviewable architecture artifact for audits, reviews, and documentation. Producers are released incrementally check individual pages for availability.