Skip to main content
Use set to change a component’s state or disposition. A successful command updates the component-owned project files immediately; review and commit those changes in your template fork.

Reference

Set the state or disposition of a named component for the active context. The component name may be prefixed with the plugin namespace: sitectl set isle/fcrepo off sitectl set blazegraph disabled This command dispatches to the plugin associated with the active context. All flags and arguments are forwarded to the plugin’s set handler. Examples: sitectl set fcrepo off sitectl set isle/fcrepo disabled sitectl set iiif triplet

Examples

Ingress settings such as TLS mode, domain, ACME email, trusted proxy IPs, upload size, and read timeout are component settings. New stacks default to http://localhost. See Ingress runtime tuning before applying upload values; backend coverage differs for PHP/nginx applications and ArchivesSpace. dev-mode --assistant writes a cli-sandbox service into docker-compose.override.yml with the plugin’s editable code mounts. The service is on the assistant profile, so start it explicitly with Docker Compose when you want an interactive coding agent.

Namespacing

The component argument may include a plugin prefix (plugin/component). This is useful when multiple plugins define components with the same name, or when targeting a component owned by a specific plugin regardless of the active context.

After setting

Running set modifies the relevant project files after any required confirmation. Use sitectl validate to confirm the result. Use sitectl converge only when later manual edits or upstream changes have caused drift.