Introducing oro-cli

[herchu]

Introducing oro-cli: configuration as code for OpenRobOps

OpenRobOps is configured through its Config API: dashboards, data sources, actions, statuses, incidents, maps, ISO 21423 robot admissions and more are all plain YAML or JSON objects you apply to an instance. That is great for keeping a fleet's setup in git and reproducing it anywhere, but until now the only way to apply those files was curl against
/api/configuration/apply, one object at a time, with no diff and no way to see what would change.

oro-cli is a small command line tool that fills that gap. It is the tool the docs and the simulator READMEs now assume you have.

• Repository: https://github.com/OpenRobOps/oro-cli
• Package: https://pypi.org/project/oro-cli/
• License: Apache 2.0

What it does

• Applies a file or a whole directory of config objects, showing a diff against what the server has before touching anything (--compare to only look).
• Lists, dumps (YAML or JSON) and deletes config objects, and lists the available kinds.
• Lists robots.
• Keeps credentials for several ORO instances as named contexts and switches between them, kubectl-style, so a local dev instance and a production one are one oro use apart. Environment variables override the config file for CI.

Try it

pipx install oro-cli          # or: pip install oro-cli

# Create an API key in the web app (Settings → API keys), then:
oro context add local --url http://localhost:3000/api --api-key <your-api-key>
oro whoami

Context: local
URL: http://localhost:3000/api
CLI version: 0.1.0
Authenticated as user 7Kq3mZpL2xWv9RtY

Apply the ISO configuration profile that ships with the Flatland simulator and admit the simulated robot:

cd sim-flatland/oro-config
oro apply -f iso/config.yaml --compare   # see what would change
oro apply -f iso/config.yaml -y          # apply it
oro apply -f iso/iso-robot.yaml
oro get robots

Pull the current state back out as YAML, edit, re-apply:

oro list kinds
oro get config --kind ActionDefinition > actions.yaml
oro apply -f actions.yaml

Notes

• Requires Python 3.12+.
• API keys are stored in plain text in ~/.config/oro/config.yaml (readable only by your user). A login flow is on the list for later.
• Files written for other configuration-as-code tools that carry a metadata.scope field still work: the field is ignored with a warning.

Issues and ideas go to the oro-cli issue tracker. The Quick Start has a setup
section for first-time use.