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.

A sitectl config can have multiple contexts. A sitectl context is a docker compose site running somewhere. “Somewhere” meaning:

on your laptop (--type local)
on a remote server (--type remote).

Remote contexts require SSH access to the remote server from where sitectl is being ran from. When creating a context the remote server DNS name, SSH port, SSH username, and the path to your SSH private key will need to be set in the context configuration. You can have a default context which will be used when running sitectl commands, unless the context is overridden with the --context flag.

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

Set or update properties of a context. Creates a new context if it does not exist.

sitectl config set-context [context-name]

Flag	Default	Description
`-f, --compose-file`	`[]`	docker compose file paths to use (equivalent to docker compose -f flag). Multiple files can be specified.
`--compose-network`		Primary Docker Compose network name for this environment
`--compose-project-name`		Docker Compose project name, matching COMPOSE_PROJECT_NAME or compose name:
`--database-name`	`drupal_default`	Name of the database to connect to (e.g. drupal_default)
`--database-password-secret`	`DB_ROOT_PASSWORD`	Name of the docker compose secret containing the database password
`--database-service`	`mariadb`	Name of the database service in Docker Compose
`--database-user`	`root`	Database user to connect as (e.g. root, admin)
`--default`	`false`	set to default context
`--docker-socket`	`/var/run/docker.sock`	Path to Docker socket
`--env-file`	`[]`	when running remote docker commands, the `--env-file` paths to pass to docker compose
`--environment`		Environment name for this context, such as local, dev, staging, or prod
`--plugin`	`core`	Owning plugin identifier for this context, such as core, isle, or drupal
`--project-dir`		Path to docker compose project directory
`--project-name`	`docker-compose`	Logical project name for this context
`--site`		Logical site name this context belongs to
`--ssh-hostname`		Remote contexts DNS name for the host.
`--ssh-key`		Path to SSH private key for remote context. e.g. ~/.ssh/id_rsa
`--ssh-port`	`2222`	Port number
`--ssh-user`		SSH user for remote context
`--sudo`	`false`	for remote contexts, run docker commands as sudo
`--type`	`local`	Type of context: local or remote

use-context

Switch to the specified context

sitectl config use-context [context-name]

delete-context

Delete a site context

sitectl config delete-context [context-name]

validate

Validate sitectl context configuration and access

sitectl config validate [context-name]

Flag	Default	Description
`--all`	`false`	Validate all configured contexts
`--format`	`section`	Report output format: section, table, json, or yaml
`--site`		Validate all contexts for a specific site

view

Print your sitectl config

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