Skip to content
Olef Docs

olef config

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.

olef config

Section titled “olef config”

Inspect, generate, and validate user/project JSON config

Terminal window
olef config --help

Output: human_or_json.

olef config paths

Section titled “olef config paths”

Print config paths, precedence, and currently loaded config files

Terminal window
olef config paths --help

Output: human_or_json.

Argument Description
--json Emit JSON instead of human text

olef config schema

Section titled “olef config schema”

Print the machine-readable config schema and example

Terminal window
olef config schema --help

Output: human_or_json.

Argument Description
--json Emit JSON instead of human text

olef config explain

Section titled “olef config explain”

Explain how config is loaded and how agents should use it

Terminal window
olef config explain --help

Output: human_or_json.

Argument Description
--json Emit JSON instead of human text

olef config init

Section titled “olef config init”

Create or update a user/project config file from CLI values

Terminal window
olef config init --help

Output: human_or_json.

Argument Description
--user Write ~/.olef/config.json Conflicts with: project.
--project Write ./.olef/config.json. This is the default Conflicts with: user.
--app <APP> Default app alias agents can use, e.g. Livd
--package <PACKAGE> Package for –app, e.g. com.example.app
--default-target <NAME> Default named target used when –device/–target are absent
--target-name <NAME> Target entry to create/update. Pair with –target-avd or –target-serial
--target-avd <AVD> Stable AVD name for –target-name Conflicts with: target_serial.
--target-serial <SERIAL> Stable physical/remote adb serial for –target-name Conflicts with: target_avd.
--target-start <TARGET_START> Target startup policy. if-needed is valid only for AVD targets Values: never, if-needed.
--target-form-factor <TARGET_FORM_FACTOR> Assert the resolved target is a mobile or TV device Values: mobile, tv.
--target-cold-boot Cold-boot the AVD when Olef starts it
--target-boot-timeout <SECONDS> AVD boot timeout in seconds (10..=900)
--app-target <NAME> Named target for –app. The alias must be created in the same command or already exist
--project-path <PATH> Default project root: where breakpoints, layout source mapping and app apply look for sources and build outputs
--module <MODULE> Gradle application module to build when not told (app apply, the build tool). With –app, for that app alias
--variant <VARIANT> Build variant to build when not told, e.g. mobileDebug. With –app, for that app alias
--debug-mode <MODE> Default debugger mode: auto, java, native, or mixed
--show-device <WHERE> How the agent shows you the device: viewer (the live viewer in the agent app’s browser pane) or window (the emulator’s own window) Values: viewer, window.
--ca-cert <PATH> Proxy signing CA certificate path (absolute or ~/). Sets proxy.ca_cert
--ca-key <PATH> Proxy signing CA private key path (absolute or ~/). Sets proxy.ca_key
--ca-trusted Assert the proxy CA is already trusted on the device (skip install + readback). Sets proxy.ca_trusted
--force Replace an existing app alias if it points at a different package
--json Emit JSON instead of human text

olef config validate

Section titled “olef config validate”

Parse and validate all discovered config files

Terminal window
olef config validate --help

Output: human_or_json.

Argument Description
--json Emit JSON instead of human text