Browse the documentation

Early preview

Command-line reference

The Compiler comes with one command-line tool, oel. It checks, formats, compiles, builds and runs your code, with diagnostics that point at your source, and it manages packages, targets, devices and deployments. This reference describes each command, one page per command.

Commands are shown without a prompt and without their output.

Projects

CommandWhat it does
oel initCreate a ready-to-build project.
oel checkCheck a project, a folder or a file without running anything.
oel fmtFormat source files, or list the files that would change.
oel compileProduce compiled files for every component.
oel refmapShow what references what, with unused code and packages.
oel buildBuild a native executable or a firmware image for one target.
oel runCheck, build and run a program in one step.
oel testRun a project's tests.
oel packageBuild a package file from your own project.
oel migrateMove a project to the current source format, with a plan, a result comparison and a rollback.
oel foreignList and try the functions a project holds in other languages.
oel scopeShow which functions a file may call and why, and plan the import that makes one callable.
oel agent compileProduce the typed description of a node or the manifest of a workflow, with a source map.

Packages

oel pack manages the packages a project uses; oel package, above, builds a package file. Keep the two apart.

CommandWhat it does
oel pack addAdd a new package to a manifest, and install it.
oel pack installInstall exactly what the manifest and lock file already say.
oel pack updateMove a package to another version its requirement allows.
oel pack removeRemove a package, keeping the packages others still need.
oel pack listList declared, installed and used packages.
oel pack whyExplain why a package is in the project.
oel pack verifyVerify installed packages against the lock file.
oel pack lockResolve and write the lock file without installing.
oel pack graphShow the dependency graph the lock file records.
oel pack lock-diffCompare two lock files.
oel pack vendorExport the locked packages for offline builds.
oel pack cache pruneRemove cached packages that nothing uses.
oel pack repairFinish or undo an interrupted package change.

Agents, prompts and configuration

CommandWhat it does
oel evalRun an evaluation suite against a prompt or model change.
oel prompt-diffShow how prompts changed against a released version.
oel prompt-package, prompt-plan, prompt-publish, prompt-activatePackage a node's behavior with its locked packages, plan a release, store it and begin an approved rollout.
oel config explainExplain where each configuration value comes from.

Targets, devices and deployment

CommandWhat it does
oel doctorReport the toolchain, installed targets and anything missing.
oel target installSet up what a target needs.
oel devicesList connected devices.
oel flashWrite a firmware image to one selected device.
oel monitorShow a device's output.
oel deployPlan a staged deployment, then apply the plan you reviewed.

Common options

OptionMeaning
--jsonMachine-readable output instead of text. See Machine-readable output.
--helpThe command's usage.
-o <path>Where to write output, for commands that write a file or a folder.
--target <target>The target to check or build for: an operating system and processor, or a microcontroller board. A board is a target of its own.

--json and --help work with every command. Platforms and deployment lists the targets.

Paths and projects

  • Most commands take an optional path. Without one, a command works on the project in the current folder.
  • A project is a folder with main.oel, pack.oel and metadata.oel at its root. Project layout describes the rest.
  • Installed packages (the .package folders) and the output the Compiler writes are never read as source.
  • Every source file has to stay within the size limit described in Limits. Commands that write source, such as oel fmt, never push a file past it.

Nothing downloads while you build

Checking, compiling, building and running use only the packages that are already installed and pinned by your lock files. These commands never look for updates, contact a registry or run package code, and a missing package is an error that names the command that installs it. Only the package commands fetch packages. With one manifest and one lock file, builds repeat, even offline.

Further capabilities

  • The command line finds references, renames safely and generates API documentation.
  • You debug at source level in standard native debuggers, with the debugging information that oel build --debug adds.
  • You record control and orchestration runs and replay them to find the first point where behavior diverged. See Reporting, logs and replay.
  • Changes to the language or project format come with explicit, reviewable migrations.

Reference