Documentation

Getting started

Delivery Boy is a single deliver binary. It finds .deliver.yml by walking up from your current directory, so every command works from anywhere inside a repository.

Install

Delivery Boy is in active development. Until packaged releases are available, build it from the repository:

git clone https://github.com/SerenitySoftware/deliveryboy.git
cd deliveryboy
task install:cli
deliver --version

The default install path is ~/.local/bin/deliver. Make sure ~/.local/bin is on your PATH.

Detect your project

From the repository you want to deploy:

deliver init

Delivery Boy detects supported project shapes and shows the config it would write. Review it, then run:

deliver init --write --host your-server.example.com --dir /var/www/your-app

Preview the release

The plan command compiles the full release without running it:

deliver validate
deliver plan
deliver deploy --dry-run

plan prints the ordered steps. --dry-run walks every phase but makes no changes.

Check the target

deliver preflight

Preflight checks the required local tools, input files, secrets, and SSH access. When it fails, the release has not built, uploaded, or changed anything.

Deploy

Commit your work, then run:

deliver deploy

Delivery Boy asks which release version you are shipping when HEAD is not tagged. It builds locally, stages the result, activates it, and runs the checks from your config.

Roll back

For release-based file and site deploys:

deliver rollback

Delivery Boy points the live path at the prior complete release. A failed check during a deploy triggers the same rollback on its own.

Next: write your configuration or review the command reference.