Skip to content
Docs

inquir compose validate

Check an inquir-compose.yaml the way a deploy would.

@inquir/compute-cliv0.4.4 · Node.js 22+

Usage#

inquir compose validatebash
inquir compose validate [dir|file] [options]

Options#

OptionDescription
--name <stack>The stack name a deploy would use; applications are named <stack>-<service>.
--workspace <id|slug>Target this workspace within your credential permissions.
--env <name>Use a named CLI credential environment.
--jsonPrint machine-readable results.

Global flags, environments and CLI credentials ↗

Examples#

Example 1bash
inquir compose validate
Example 2bash
inquir compose validate examples/shop --name shop
Example 3bash
inquir compose validate stack/inquir-compose.yaml --json

Behavior#

The platform’s own validator judges the file, so you see every error and warning a deploy would report and, for a valid file, the plan: services in deploy order, CPU, memory and volumes. The command exits with code 1 when the file has errors.

From the stack folder (or the folder of the named file), the CLI sends only the files the validator asks for: each service’s inquir.yaml and Dockerfiles, up to 64 KiB each and inside that folder. Dot-files and anything else never leave your machine.

Guides#