Skip to content

CLI Reference

Oore CI provides two command-line tools:

  • oored — the daemon (control plane and API server)
  • oore — the operator CLI for setup, administration, and daily use

oored (Daemon)

The daemon serves the HTTP API and manages instance state.

Commands

CommandDescriptionStatus
oored runStart the daemonImplemented
oored install-serviceInstall as a macOS launchd servicePlaceholder
oored uninstall-serviceRemove the launchd servicePlaceholder
oored versionPrint version informationImplemented

oored run

bash
oored run [--listen <addr>] [--state-file <path>]
FlagDefaultEnv varDescription
--listen127.0.0.1:8787OORED_LISTEN_ADDRAddress and port to listen on
--state-filePlatform defaultOORE_SETUP_STATE_FILEOverride database path

The default database path is ~/Library/Application Support/oore/oore.db. The encryption key is stored at ~/Library/Application Support/oore/encryption.key.

In default mode, oored starts an embedded local runner automatically. Set OORED_RUNNER_MODE=external to disable the embedded runner and require an external runner process.

oore (Operator CLI)

The operator CLI handles setup, authentication, and administration.

Commands

CommandDescriptionStatus
oore setupInteractive 4-step instance setupImplemented
oore setup tokenGenerate a bootstrap tokenImplemented
oore loginAuthenticate in local mode or import a tokenImplemented
oore statusShow setup status and authenticated operational summaryImplemented
oore runner registerRegister an external build runnerImplemented
oore runner startStart external runner processImplemented
oore config set <key> <value>Set CLI configuration valuesImplemented
oore config get <key>Get CLI configuration valuesImplemented
oore doctorRun environment/signing diagnosticsImplemented

Global behavior

  • All commands that communicate with the daemon accept --daemon-url (default: http://127.0.0.1:8787, env: OORE_DAEMON_URL)
  • The CLI stores local defaults in ~/.oore/config.json (override path via OORE_CONFIG_FILE)
  • State database path can be overridden with --state-file or OORE_SETUP_STATE_FILE
  • Default database location: ~/Library/Application Support/oore/oore.db

Embedded runner note

The single-host default flow does not require oore runner start. The daemon (oored) auto-starts an embedded local runner unless OORED_RUNNER_MODE=external.

Self-hosted mobile CI, built for Flutter.