Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Getting started

Osmiron does not yet have a published installation or hosted onboarding flow. With the current repository checkout, you can check Osmiron Schema Language (OSL) source and receive diagnostics tied to source spans.

Create model.osl at the repository root:

entity "vehicle-1" {
    description {
        name = "Service vehicle"
    }

    capacities {
        payload_mass = 800 kg
    }

    properties {
        payload_mass = 0 kg
    }

    traits [vehicle]
}

Check it from the repository root:

cargo run -p osmiron-dsl -- check model.osl

The command produces no output and exits successfully when parsing and the currently implemented change generation succeed. It writes a source diagnostic to standard error and exits with a failure status when either stage returns an error.

A successful check is not yet proof that every declaration became a semantic change or that the resulting changes satisfy the engine model. The command does not apply changes, store a model, or produce a plan. See Current limitations before relying on it in tooling.

Continue with the OSL overview, or read the CLI guide for standard input and diagnostic controls.

The developer surfaces have distinct roles:

SurfaceRoleCurrent status
OSLDeclarative source for operational model changesParsing, source diagnostics, and partial change generation exist in this repository.
Osmiron SDKPublic name for developer librariesNo supported public package is published from this repository yet.
Osmiron APIAuthenticated customer-facing data planeThe contract is under development.