validate to catch misconfigurations before they become runtime failures. It combines core sitectl checks with plugin-specific checks in a single report.
Reference
Validate the active context’s configuration and project layout. Core checks include: required context fields, compose project presence, context file accessibility, override symlink, and Docker socket access. If the active context’s plugin registers a validate handler, plugin-specific checks (e.g. Drupal rootfs path, component state consistency) are also run and merged into the report. All flags not consumed by sitectl itself are forwarded to the plugin’s validate handler, allowing plugin-specific flags such as--drupal-rootfs.
Exits non-zero if any check fails.
Examples:
sitectl validate
sitectl validate --format table
sitectl validate --drupal-rootfs drupal/rootfs
Output formats
The--format flag controls how the report is rendered:
| Format | Description |
|---|---|
section | Human-readable sections (default) |
table | Compact table |
json | Machine-readable JSON |
yaml | Machine-readable YAML |
When to run it
- After
sitectl config set-contextto verify the new context is wired correctly. - Before deploying to confirm component state is consistent.
- When
sitectl compose upfails with an unexpected error — validate often points to the root cause.
Plugin validators
If the active context’s plugin registers a validate handler, its checks are merged automatically into the same report. For the ISLE plugin this includes: Drupal rootfs path, Traefik configuration, and per-component drift state. Plugin-specific flags (e.g.--drupal-rootfs) are passed through to the plugin’s validator unchanged.