⚓ Shipyard

Shipyard is a lightweight CLI for managing local Docker development stacks.

It provides a single command — dev — to start projects, attach to containers, view logs, and manage your development environment.

---

Quick Example

dev up
dev up api-gateway

dev attach api-gateway
dev logs web api-gateway

dev list
dev down

---

What Shipyard Solves

Managing multiple Docker Compose projects can become repetitive and inconsistent.

Shipyard provides a simple, consistent interface for:

• Starting project stacks
• Attaching to containers
• Viewing logs
• Restarting services
• Checking environment status
• Diagnosing setup issues

All from a single command.

---

CLI Philosophy

Shipyard focuses on:

• Consistency across projects
• Minimal commands
• Fast developer workflows
• Zero complexity

Most developers only need to remember:

dev up
dev attach
dev logs
dev list
dev down

---

Installation

Shipyard can be installed in two ways.

---

Quick Install (recommended)

Install Shipyard directly using curl:

curl -fsSL https://raw.githubusercontent.com/dstuchbury/shipyard/main/install.sh | bash
source ~/.bashrc

Then verify the installation:

dev doctor

The installer will:

• Install yq if required
• Clone Shipyard to ~/.shipyard
• Install the dev command to ~/.local/bin
• Add ~/.local/bin to your PATH if needed

---

Install From Repository

If you prefer to review the code before installing:

git clone https://github.com/dstuchbury/shipyard.git
cd shipyard
./install.sh
source ~/.bashrc

Then verify:

dev doctor

---

Updating Shipyard

To update Shipyard in the future, simply rerun the installer:

curl -fsSL https://raw.githubusercontent.com/dstuchbury/shipyard/main/install.sh | bash

Or if you installed via git:

cd ~/.shipyard
git pull

---

Configuration

Edit the project configuration file:

config/projects.yml

Example:

master:
  path: ~/phpdev
  composeFileName: docker-compose.yml

projects:
  - name: api-gateway
    path: ~/code/php/api-gateway
    composeFileName: docker-compose-dev-wsl.yml
    appContainer: api-fpm
    webContainer: api-nginx

  - name: status-notification-service
    path: ~/code/php/status-notification-service
    composeFileName: docker-compose-dev-wsl.yml
    appContainer: sns-fpm
    webContainer: sns-nginx

Each project requires:

Field	Description
name	Name used in CLI commands
path	Folder containing the docker compose file
composeFileName	Docker compose file name
appContainer	PHP / application container name
webContainer	Web server container name

---

Commands

Start master stack

dev up

---

Start a project

dev up api-gateway

---

Stop everything

Stops:

• master compose stack
• all configured projects

dev down

---

Stop a specific project

dev down api-gateway

---

Restart a project

dev restart api-gateway

---

Container Access

Shipyard can automatically attach to containers.

If the project is not running, it will automatically start it.

---

Attach to application container

dev attach api-gateway

---

Attach to web container

dev attach web api-gateway

---

Logs

Application container logs

dev logs api-gateway

---

Web server logs

dev logs web api-gateway

Logs will follow the container output.

---

Project Status

Show all configured projects and whether they are running.

dev list

Example output:

PROJECT                              STATUS
------------------------------------ ------------
api-gateway                          🟢 running
status-notification-service          🔴 stopped

---

Diagnostics

Run environment checks.

dev doctor

This verifies:

• Docker installed
• Docker Compose available
• yq installed
• Configuration file present
• Project configuration validity
• Project running status

---

Typical Workflow

Start environment:

dev up

Start a project:

dev up api-gateway

Attach to PHP container:

dev attach api-gateway

View logs:

dev logs api-gateway

Check status:

dev list

Shutdown everything:

dev down

---

Philosophy

Shipyard focuses on:

• Consistency across projects
• Minimal commands
• Fast developer workflows
• Zero complexity

Most developers only need to remember:

dev up
dev attach
dev logs
dev list
dev down

---

License

MIT Licence

Copyrigy 2026 Dan Stuchbury

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.