Skip to main content
Components are optional services in your stack — things like fcrepo or Blazegraph — that can be switched on or off without rebuilding the whole project. sitectl delegates component management to the plugin for the active context, so the same commands work across different stack types. See the components concept page for an explanation of what components are and how they work.

component

Components are optional stack features — such as Fcrepo or Blazegraph — that can be toggled on or off. sitectl dispatches component commands to the plugin associated with the active context. The plugin provides the component registry; sitectl provides a consistent entry point regardless of which stack you are working with.
sitectl component <command>

describe

Show the current state of each component registered by the active context’s plugin. Each component is reported as on, off, or drifted. A drifted component means the project files no longer match the last recorded state — run reconcile to bring them back into alignment.
sitectl component describe
Aliases: status
FlagDefaultDescription
-c, --componentComponent to describe, e.g. isle/fcrepo. Defaults to all components.
--drupal-rootfsPath to the Drupal web root, relative to --path.
--formatOutput format (default: table).
--pathPath to the project directory. Defaults to the active context project directory.
--verbosefalseShow additional details for each component.

reconcile

Inspect each component and apply any changes needed to bring the project back into alignment. By default the command is interactive and asks before applying changes. Pass --report to preview what would change without applying it.
sitectl component reconcile
Aliases: review, align
FlagDefaultDescription
-c, --componentComponent to reconcile, e.g. isle/fcrepo. Defaults to all components.
--drupal-rootfsPath to the Drupal web root, relative to --path.
--formatOutput format (default: table).
--pathPath to the project directory. Defaults to the active context project directory.
--reportfalsePreview changes without applying them.
--verbosefalseShow additional details for each component.
A component shows as drifted when its project files no longer match its last recorded state — for example, if someone manually edited a Compose file. Run reconcile to bring the project back into alignment.

set

Set the state or disposition of a named component in the active context’s plugin. Prefix the component name with the plugin namespace to target it directly: sitectl component set isle/fcrepo off sitectl component set isle/blazegraph off
sitectl component set <component> [disposition]
FlagDefaultDescription
--dispositionDisposition to apply (enabled, disabled, superceded, distributed).
--drupal-rootfsPath to the Drupal web root, relative to --path.
--pathPath to the project directory. Defaults to the active context project directory.
--stateState to apply (on, off).
--tls-modeTLS mode (http, self-managed, mkcert, letsencrypt).
--yolofalseSkip the confirmation prompt.