Skip to content

olef commands

CLI v3.0.2View Markdown

Generated from Olef 3.0.2. All commands · Capabilities and requirements

These entries describe available commands, not a sequence to run. Check prerequisites before changing app, device, or cloud state. Global options are listed in the command catalog.

Emit the full command catalog (machine-readable self-introspection for agents)

Terminal window
olef commands --help

Output: human_or_json.

Argument Description
<path> Command path to inspect directly, e.g. net rule add Conflicts with: depth, describe, guide, search.
--json Emit JSON instead of a human tree
--depth <N> Limit command-tree expansion (1 = top-level routing catalog) Conflicts with: describe, guide, path, search.
--describe <COMMAND_PATH> Return one command contract by its space-separated path, e.g. “ui tap” Conflicts with: depth, guide, path, search.
--search <QUERY> Search command names, summaries, argument help, and examples Conflicts with: depth, describe, guide, path.
--guide <TOPIC> Return the driving guide for a domain before first use: workflow, verification, test (test scripts, sessions with settings, test runs), evidence, net, debugger, faults, state, feedback (reporting Olef bugs), or cloud. Covered command groups alias to their guide (ui → workflow; verify/session → verification; video → evidence; debug/layout/runtime → debugger; fault → faults; app/device/perm/appops/profile/files → state) Conflicts with: depth, describe, path, search.
--full Include long agent guidance and every argument field. JSON output is compact by default (the invocation contract without guidance)
--compact Accepted for compatibility: compact is the default Conflicts with: full.

Examples from the CLI (replace sample packages, selectors, and paths with your own):

Terminal window
olef commands --json --depth 1
olef commands net rule add --json --compact
olef commands --search 'response body' --json
olef commands --guide net --json