Quickstart

Learn the sitectl command shape and the core areas to explore after installation.

Setup

After installing sitectl, start by running:

sitectl

Running sitectl with no arguments opens the , where you can:

Set up an existing site

Connect sitectl to a project you already run locally or remotely.

Create a new site

Use the guided flow to start a new site with the available stack-specific tooling.

Monitoring

After you setup or install a site, you can use sitectl to monitor the health of the docker compose project.

Information like general container health, host stats, and logs will all be available in the sitectl dashboard.

Operations

After you’ve configured your site(s) and environment(s) as sitectl contexts, you can begin using sitectl to help with site operations.

You can also run individual commands directly for one-off tasks when you do not need the full flow.

The main areas to learn from there are:

Contexts

Describe a site and its environments so sitectl knows how to connect and operate.

Compose commands

Run commands through sitectl against local and remote contexts.

Plugins

Add stack-specific behavior for the technologies your sites use.

Components

Work with reviewed operator defaults for optional parts of a stack.

Basic command shape

sitectl <command> [subcommand] [flags]

Common top-level commands:

sitectl config

Manage your sitectl contexts.

sitectl compose

Run docker compose commands on any sitectl context

sitectl port-forward

Use SSH port forwarding for one of your remote services to your local machine.

sitectl sequelace

For macOS open a connection to a mariadb/mysql database using SequelAce