DOCK<
v0.2.1 • LOCAL-FIRST WORKFLOW

CONFIGUREONCE.INITIALIZEANYWHERE.

DEPLOYMENT|OPERATIONS &|CONFIGURATION|KIT
Scroll↓

Dock (Deployment Operations and Configurations Kit) is a local-first project setup CLI. Describe a project in dock.yaml, and Dock validates the config and coordinates your local Docker installation to initialize and run the container.

# Install via PyPIpip
python -m pip install dock-api
Get started→Read the docs

The V1 Loop

From config
to container.

A predictable, repeatable lifecycle for projects starting from a published Docker image or a GitHub repository.

1validate: Checks YAML syntax only
2plan / sync: Concise plan or full state comparison
3init: Applies plan & starts containers
4status: Inspects system & project containers
your terminal
$ python -m pip install dock-api
$ dock validate -c ./dock.yaml
✓ dock.yaml is valid

$ dock plan -c ./dock.yaml
Plan (hello-nginx):
  - Pull published image: nginx:alpine
  - Bind port: host 8080 -> container 80
  - Health check: http GET / on port 80

$ dock sync -c ./dock.yaml
(State comparison: read-only preview of host prerequisites & container changes)

$ dock init -c ./dock.yaml
✓ Image pulled: nginx:alpine
✓ Container dock-hello-nginx created and started
✓ HTTP health check passed on http://localhost:8080/

$ dock status --running -c ./dock.yaml
Project: hello-nginx
System Requirements: Satisfied
Docker: Running
Containers (Running):
  - dock-hello-nginx (Up 2m, Port 8080 -> 80)

How it works

A clear path
to running code.

01

dock.yaml

Project definition: published image or GitHub source, port bindings, and HTTP health check.

02

Dock CLI

Validates config with dock validate, inspects with dock plan / sync, and applies with dock init.

03

Docker Engine

Uses your machine's Docker daemon to pull published images or build local images from Git.

04

Running Container

Executes the container locally with mapped ports and verifies the configured HTTP health check.

Two Starting Points

Bring the image or source.
Dock handles the local setup.

Dock V1 supports one application per dock.yaml, delegating execution to your local Docker installation.

01 • Published Image↗

Run a published image

Point application.image at Docker Hub or GHCR. Dock pulls the image and starts the container locally with mapped ports.

dock sync→dock init
02 • GitHub Build↗

Build from GitHub

Provide application.source with type: github and a Dockerfile. Dock fetches the branch and builds it locally.

fetch branch→docker build→dock init

Command Surface

Focused CLI.
Explicit state.

Each command does one explicit job in the local project lifecycle, ensuring your container setup is transparent and repeatable.

V1 Scope Note: Multi-container selectors, cloud deployment, and live-follow logs (-f) are not in V1.
$dock validate
Validates dock.yaml schema and structure only (does not check or install host prerequisites).
$dock status
Reports host, Docker, requirements, and project container status (supports --running and --stopped filters).
$dock plan
Concise list of pending prerequisite installations and application provisioning actions (supports --json).
$dock sync
Full read-only comparison between configuration and current system/project state, previewing planned changes.
$dock init
Applies the plan: installs prerequisites, pulls/builds images, starts containers, and checks health endpoints.
$dock start
Starts stopped Dock-managed project containers.
$dock stop
Stops Dock-managed project containers while preserving container state.
$dock logs
Displays recent container stdout/stderr output (accessible even after stopping).
$dock -v
Prints the installed Dock CLI version.