# CLI reference

Generated from the code · as of CLI 0.6.0

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`](https://docs.omniarc.eu/cli/check.md) | Run the checks a deploy would, locally, and upload nothing. |
| [`omniarc sync`](https://docs.omniarc.eu/cli/sync.md) | Draft or refresh arc.yaml from compose's own model. |
| [`omniarc deploy`](https://docs.omniarc.eu/cli/deploy.md) | Deploy this compose project. Creates the arc if it does not exist. |
| [`omniarc env`](https://docs.omniarc.eu/cli/env.md) | The arc's .env: one file for every branch, values write-only. |
| [`omniarc arc`](https://docs.omniarc.eu/cli/arc.md) | Your organization's arcs: create, inspect, branch and destroy them. |
| [`omniarc key`](https://docs.omniarc.eu/cli/key.md) | Your organization's API keys: list, create and revoke them. |
| [`omniarc costs`](https://docs.omniarc.eu/cli/costs.md) | What this organization's usage costs: an estimate, not an invoice. |
| [`omniarc commands`](https://docs.omniarc.eu/cli/commands.md) | Every command, its arguments and what it returns. |