CLI / oroc

oroc

Build, run, and manage Oro applications.

Usage#

oroc <command> [options]
oroc help [query...]

Commands#

Command Description
build build project
config inspect configuration values and docs
env print relevant environment variables
help search commands, options, and platform notes
init create a new project (in the current directory)
install-app install app to the device
install alias for install-app
language-server run Oro Language Server over stdio
list-devices get the list of connected devices
devices alias for list-devices
mcp run an MCP server for agent tooling
print-build-dir print build path to stdout
push run a local UnifiedPush development server
run run application
setup install build dependencies
tooling export and prepare editor compilation models
update update tooling (keys, manifests, bundles)
version inspect or bump project version
versions print runtime and dependency versions

General options#

Option Description
-h, --help show help
--prefix print install path
-v, --version print program version
-q, --quiet hint for less log output
-V, --verbose enable verbose output (can be global)
-D, --debug enable debug output (can be global)
--no-color disable colored log output
--json enable structured JSON logs on stdout
--log-file=<path> mirror logs to a JSON file

Environment#

Variable Description
ORO_DEBUG enable debug mode (like -D)
ORO_VERBOSE enable verbose logs (like -V)
ORO_LOG_NO_COLOR disable colored log output
ORO_LOG_JSON enable structured JSON logs on stdout
ORO_LOG_FILE mirror logs to a JSON file
ORO_ALLOW_EXEC allow native extension commands during builds
ORO_ENABLE_SANITIZERS enable ASan/UBSan on desktop builds
NO_ANDROID source bootstrap: disable only Android work when non-empty
NO_IOS source bootstrap: disable only iOS/iOS Simulator work when non-empty

Notes#

Run 'oroc <command> --help' for usage and options; see the command's man page for examples and platform guidance.

Use 'oroc help <query>' to search commands, options, examples, and workflow notes by topic. 'oroc <subcommand> --json' emits structured command results when that subcommand supports it.

The global 'oroc --json <subcommand>' form is reserved for JSON log streaming.

Use '--log-file=<path>' when you need machine-readable stdout plus a separate log stream.

NO_ANDROID and NO_IOS are independent presence flags for building the runtime source tree; they do not select an application target for 'oroc build --platform'. Values such as 0 and false are non-empty and still disable the named target.

Examples#

oroc init my-app

create a starter Oro project in ./my-app

oroc run .

run the app rooted at the current directory

oroc build --platform=ios --prod .

build a production iOS artifact from the current project

oroc config --describe meta.version

inspect documentation for a single configuration key

oroc help ios signing

search for commands and notes related to iOS signing and provisioning

Update tooling#

Command Description
oroc update keygen generate an Ed25519 keypair for signing update manifests
oroc update init scaffold a manifest JSON file
oroc update server run an update server over HTTP/TCP/UDP
oroc update info query update servers or static manifests over HTTP/TCP/UDP
oroc update sign sign a manifest JSON file and emit a sidecar signature
oroc update verify verify a manifest JSON file + signature using a public key
oroc update bundle build a tar archive from a directory suitable as an update artifact
oroc update extract extract an update bundle tar archive into a directory
oroc update validate validate a manifest.json file against the update manifest schema shape

Source repository · Edit this page · View Markdown

Quick links

Type to search across the site. Use the up and down arrow keys to choose a result, Enter to open it, and Escape to close.