CLI reference

These are the commands for working with your arcs from a terminal. omniarc <command> --help prints the same text on your machine, and omniarc commands lists every command with its arguments, for scripts and agents.

# Where the commands connect

Variable	What it is
OMNIARC_KEY	Your organization's API key. Every command that talks to OmniArc sends it. check, sync and commands run on your machine and do not need it.
OMNIARC_ORCHESTRATOR	Where the commands connect. It defaults to https://dashboard.omniarc.eu, so leave it unset.

# Options on every command

• --json: Print machine-readable JSON instead of a table. Not on deploy, which prints progress instead.

# Commands

Command	What it does
omniarc check	Run the checks a deploy would, locally, and upload nothing.
omniarc sync	Draft or refresh arc.yaml from compose's own model.
omniarc deploy	Deploy this compose project. Creates the arc if it does not exist.
omniarc env	The arc's .env: one file for every branch, values write-only.
omniarc arc	Your organization's arcs: create, inspect, branch and destroy them.
omniarc key	Your organization's API keys: list, create and revoke them.
omniarc costs	What this organization's usage costs: an estimate, not an invoice.
omniarc commands	Every command, its arguments and what it returns.