# omniarc check

Generated from the code · as of CLI 0.6.0

Run the checks a deploy would, locally, and upload nothing.

Always covers the bundle rules (what a deploy may contain), the rules of arc.yaml itself, and the files your compose file includes or extends. When `docker compose` is installed on this machine it also checks how arc.yaml's entries line up with your compose services, and which compose features arcs support. It is advisory: the checks on the node decide.

Variables your compose files use without a default are checked against the names in your arc's .env, read with OMNIARC_KEY (never a value). Errors stop a deploy, warnings deserve a look, and notes (what the checks did on the way) are counted but shown only with --verbose.

```text
omniarc check [OPTIONS]
```

Options:

- `--dir <DIR>`: The project directory: the one holding the compose file and arc.yaml. Default: `.`.
- `--verbose`: Also print the notes, and each repeated warning on its own line.
- `--offline`: Do not ask for your arc's .env names: compare variables with this directory's .env instead, and report them as warnings.
- `--json`: Print machine-readable JSON instead of a table.

## See also

- [The arc.yaml reference](https://docs.omniarc.eu/reference/arc-yaml.md)
- [What compose features run, and what is refused](https://docs.omniarc.eu/reference/compose-support.md)