config

A sitectl context points to a site running either on your local machine or on a remote server over SSH. You can have many contexts and switch between them with use-context. See the context concept page for a full explanation.

Manage the saved connection records sitectl uses to target Docker Compose sites. Each context identifies one local or SSH-accessible site environment, its project and Compose identity, and the application plugin that owns stack-specific behavior. The default context is used only when neither --context nor the current directory selects another environment.

sitectl config <command>

current-context

Display the current site context

sitectl config current-context

get-contexts

List all site contexts

sitectl config get-contexts

get-environments

List environments grouped by site

sitectl config get-environments [site]

get-sites

List configured sites and their environments

sitectl config get-sites

set-context

Create or update a context that tells sitectl which Docker Compose project to operate. The context records the site and environment identity, project directory, Compose identity, Docker endpoint, and—when the target is remote—its SSH connection. Use --default to make this the fallback target for commands that omit --context.

sitectl config set-context <context-name>

Flag	Default	Description
`-f, --compose-file`	`[]`	Compose files passed as Docker Compose -f options in this order; may be repeated.
`--compose-network`		Primary Docker Compose network sitectl uses to resolve and connect to stack services.
`--compose-project-name`		Docker Compose identity used to name and label this stack’s containers, volumes, and networks.
`--database-name`	`drupal_default`	Default database schema shared backup, restore, and sync jobs operate on.
`--database-password-secret`	`DB_ROOT_PASSWORD`	Compose secret name shared jobs read for the database password; this stores the reference, not the password.
`--database-service`	`mariadb`	Compose service that shared database backup, restore, and sync jobs execute against.
`--database-user`	`root`	Database account shared jobs use inside the database service; no password is stored here.
`--default`	`false`	Use this context when a command does not select one explicitly.
`--docker-socket`	`/var/run/docker.sock`	Unix socket where Docker accepts API requests on the target machine.
`--env-file`	`[]`	Environment files passed to Docker Compose in this order; paths resolve on the target machine.
`--environment`		Deployment label within the site, such as local, dev, staging, or prod.
`--plugin`	`core`	Application plugin that owns stack-specific behavior for this context, such as isle or drupal.
`--project-dir`		Docker Compose project directory on the target machine; relative Compose and env files resolve from here.
`--site`		Logical site shared by related environment contexts, such as museum-local and museum-prod.
`--ssh-hostname`		DNS name or IP address of the remote machine that hosts the stack.
`--ssh-key`		Private key used to authenticate to the remote host; the key contents are not stored in the context. Example: ~/.ssh/id_rsa
`--ssh-port`	`22`	TCP port used to establish the remote SSH connection.
`--ssh-user`		Remote account whose permissions sitectl uses for Docker and filesystem operations.
`--type`	`local`	Execution target: local runs Docker on this machine; remote runs it over SSH.
`--yolo`	`false`	Save resolved flag, stored-context, and product defaults without reviewing each decision.

use-context

Switch to the specified context

sitectl config use-context <context-name>

delete-context

Delete a saved context from the local sitectl configuration. By default, this removes only the connection record and leaves containers, volumes, remote resources, and project files unchanged. With --delete-project, a local context requires two typed confirmations before sitectl runs docker compose down -v, deletes the complete project directory, and removes the saved context. Remote project files and containers are never deleted by this command.

sitectl config delete-context <context-name>

Flag	Default	Description
`--delete-project`	`false`	For a local context, also delete its Compose volumes and complete project directory after a second typed confirmation.

validate

Validate sitectl context configuration and access

sitectl config validate [context-name]

Flag	Default	Description
`--all`	`false`	Validate configuration and target access for every saved context.
`--format`	`section`	Report output format: section, table, json, or yaml
`--site`		Validate every environment context belonging to this logical site.

view

Print the complete persisted sitectl configuration

sitectl config view

Getting started

Concepts

Commands

config

config

current-context

get-contexts

get-environments

get-sites

set-context

use-context

delete-context

validate

view

​config

​current-context

​get-contexts

​get-environments

​get-sites

​set-context

​use-context

​delete-context

​validate

​view

config

current-context

get-contexts

get-environments

get-sites

set-context

use-context

delete-context

validate

view