Skip to content

Documentation

Technical references for understanding, running and reasoning about Orvienm

Getting StartedCLI Reference

Technical references for the current Alpha, in the order they are useful: set up and run the CLI, understand what each stage does, look up the specification format and the commands, then diagnose failures. Every entry links to a page that exists today.

Source

The CLI is distributed as source from github.com/kw13j1qs0/orvienm-polaris, Apache-2.0. There is no package index release yet; Getting Started has the clone and install commands.

Start here

Getting Started

Install from source, write a specification, then run validate, plan, apply and verify end to end.

Understand the model

Execution Model

What each stage reads and writes, how to read a plan, what drift means, and what counts as converged.

Validation Model

Every check performed before execution, how failures are reported, and what validation does not cover.

Engine Design

The modules the engine is built from, what each one owns, and where the filesystem boundary falls.

Architecture Overview

The surfaces Orvienm is built from and where the specification and workspace sit between them.

Reference

Specification Reference

Every key, value and rule the specification format accepts, the lock file and drift, and what this Alpha does not support.

CLI Reference

All eleven commands with their arguments, flags, behaviour and exit codes.

Operate

Troubleshooting

What each failure means, what to check, and the safe next step — organised by exit code.