sitectl

command module
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 11, 2026 License: MIT Imports: 1 Imported by: 0

README

sitectl CLI

Command line utility to interact with your local and remote docker compose sites.

Why sitectl vs Docker Context?

While Docker's native context feature handles basic daemon connections, sitectl is purpose-built for Docker Compose projects and adds:

  • Enhanced remote operations: SFTP file operations (read env files, upload/download), sudo support, and helpful SSH error messages
  • Container utilities: Resolve service names to containers, extract secrets/env vars to better support exec operations inside containers, get container IPs within Docker networks
  • Plugin architecture: Extend sitectl for project-specific needs (e.g. islandora, drupal, etc.)
  • Service management: Enable/disable services in docker-compose.yml with automatic cleanup of orphaned resources and Drupal configuration
  • Compose-first design: Set the equivalent of DOCKER_HOST, COMPOSE_PROJECT_NAME, COMPOSE_FILE, COMPOSE_ENV_FILES automatically based on sitectl context settings

Attribution

  • The config commands for setting contexts were heavily inspired by kubectl

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL