Skip to main content
Use healthcheck to verify that the active context’s site is up. Core checks confirm the service containers are running and healthy. If the context’s plugin registers a healthcheck handler, its runtime checks run too and are merged into the report. The command exits non-zero if any check still fails after the timeout, so it is safe to use in scripts and CI.

​
Reference

Check whether the active site is online. Core checks verify Docker Compose service containers are running and healthy. If the active context’s plugin registers a healthcheck handler, plugin-specific runtime checks are also run and merged into the report. All flags not consumed by sitectl itself are forwarded to the plugin’s healthcheck handler, allowing plugin-specific flags such as --codebase-rootfs. By default, healthcheck waits for Docker services that are still starting, then prints one status report and exits non-zero if any check fails. Use --persist to keep retrying all failures until every check passes or --timeout is reached. Examples: sitectl healthcheck sitectl healthcheck --persist --timeout 10m --interval 15s sitectl healthcheck --format table 
sitectl healthcheck [flags]

​
Common workflows

# Check the active context
sitectl healthcheck

# Wait longer for a slow stack to come up
sitectl healthcheck --timeout 10m --interval 15s

# Render the report as a table
sitectl healthcheck --format table
Flags that core does not consume are forwarded to the plugin’s healthcheck handler, so plugin-specific flags such as --codebase-rootfs work here too.