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
| Command | What it does |
|---|---|
oel init | Create a ready-to-build project. |
oel check | Check a project, a folder or a file without running anything. |
oel fmt | Format source files, or list the files that would change. |
oel compile | Produce compiled files for every component. |
oel refmap | Show what references what, with unused code and packages. |
oel build | Build a native executable or a firmware image for one target. |
oel run | Check, build and run a program in one step. |
oel test | Run a project's tests. |
oel package | Build a package file from your own project. |
oel migrate | Move a project to the current source format, with a plan, a result comparison and a rollback. |
oel foreign | List and try the functions a project holds in other languages. |
oel scope | Show which functions a file may call and why, and plan the import that makes one callable. |
oel agent compile | Produce 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.
| Command | What it does |
|---|---|
oel pack add | Add a new package to a manifest, and install it. |
oel pack install | Install exactly what the manifest and lock file already say. |
oel pack update | Move a package to another version its requirement allows. |
oel pack remove | Remove a package, keeping the packages others still need. |
oel pack list | List declared, installed and used packages. |
oel pack why | Explain why a package is in the project. |
oel pack verify | Verify installed packages against the lock file. |
oel pack lock | Resolve and write the lock file without installing. |
oel pack graph | Show the dependency graph the lock file records. |
oel pack lock-diff | Compare two lock files. |
oel pack vendor | Export the locked packages for offline builds. |
oel pack cache prune | Remove cached packages that nothing uses. |
oel pack repair | Finish or undo an interrupted package change. |
Agents, prompts and configuration
| Command | What it does |
|---|---|
oel eval | Run an evaluation suite against a prompt or model change. |
oel prompt-diff | Show how prompts changed against a released version. |
oel prompt-package, prompt-plan, prompt-publish, prompt-activate | Package a node's behavior with its locked packages, plan a release, store it and begin an approved rollout. |
oel config explain | Explain where each configuration value comes from. |
Targets, devices and deployment
| Command | What it does |
|---|---|
oel doctor | Report the toolchain, installed targets and anything missing. |
oel target install | Set up what a target needs. |
oel devices | List connected devices. |
oel flash | Write a firmware image to one selected device. |
oel monitor | Show a device's output. |
oel deploy | Plan a staged deployment, then apply the plan you reviewed. |
Common options
| Option | Meaning |
|---|---|
--json | Machine-readable output instead of text. See Machine-readable output. |
--help | The 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.oelandmetadata.oelat its root. Project layout describes the rest. - Installed packages (the
.packagefolders) 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 --debugadds. - 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
- Diagnostics: what a diagnostic tells you, in text and in JSON.
- Machine-readable output:
--json, report formats and exit status.