Command Reference

2 min read
Suggest an Edit

The Lexum command line interface is the primary mechanism for interacting with the language, compiling deterministic orchestrations, and interacting with the Virtual Control Runtime.

Project Management

Lexum init <project_name>

Bootstraps a new Lexum project, creating the root Lexum.toml configuration file, standard directory architecture, and setting up the local simulation harnesses.

Lexum build [--target <target>]

Assembles the Lexum source files into a compiled runtime artifact. The build command executes the complete type checking pass (both for data shapes and authority scopes).

Verification & Safety

Lexum check

A fast, read-only parsing pass that verifies syntax and lightweight type bindings without attempting to structure the full Effect DAG or generate artifacts. Ideal for IDE integration loops.

Lexum lint

Initiates the mathematical verification engine. It probes the workspace for statistical threats, missing idempotency keys in Effects, potential target oscillation loops, and unresolved schema migration branches.

Emulation

Lexum simulate <test_name>

Because Lexum systems run for months at a time, you cannot test them synchronously. This command launches the Deterministic Replay Engine, rapidly advancing logical time to verify your Domain's convergence guarantees over simulated weeks of operation.

Operations

Lexum runtime start [--cluster]

Spins up a local instance of the Virtual Control Runtime, initializing the Mailbox router, mounting the Snapshot persistence layer, and loading active domains.

Lexum inspect <snapshot_file> [--query <json_path>]

Mounts a physical snapshot file completely offline, allowing operators to arbitrarily query the exact internal state of a Domain without waking up the execution loop.