Specifications

Technical specifications and design documents for Shipper CLI.

Spec: Deployment Atomic Rollback

**Date:** 2026-04-26 **Status:** Draft When `AbstractProvider::apply()` fails mid-deployment (steps 2-15 after site crea

Spec: Build System — PHAR Compilation and Distribution

**Issue:** MAR-41 **Date:** 2026-04-24 **Status:** In Review Shipper is built as a standalone PHAR binary using Box (box

Spec: CLI Commands

**Issue:** MAR-19 **Date:** 2026-04-23 **Status:** In Review Shipper exposes a declarative deployment workflow through a

Spec: Configuration System

**Issue:** MAR-18 **Date:** 2026-04-23 **Status:** In Review The configuration system parses a single `shipper.yml` file

Spec: Deployment Execution

**Issue:** MAR-35 **Date:** 2026-04-23 **Status:** In Review Deployment execution in Shipper is the process of taking a

Spec: Domain Aliases

**Issue:** MAR-30 **Date:** 2026-04-23 **Status:** In Review Domain aliases allow a deployment to associate additional d

Spec: Forge Provider

**Issue:** MAR-39 **Date:** 2026-04-23 **Status:** In Review The Forge provider bridges Shipper's deployment pipeline to

Spec: GitHub Actions Integration

**Issue:** MAR-40 **Date:** 2026-04-24 **Status:** In Review Shipper ships two GitHub Actions integration points: (1) re

Spec: Implement DeployCommand

**Date:** 2026-04-26 **Status:** Draft `DeployCommand` currently exists as a stub/no-op. This spec defines what it shoul

Spec: Database Management

**Issue:** MAR-22 **Date:** 2026-04-24 **Status:** In Review Shipper manages database lifecycle for Laravel applications

Spec: Environment Variables

**Issue:** MAR-23 **Date:** 2026-04-24 **Status:** In Review Shipper manages environment variables by merging project an

Spec: Queue Workers

**Issue:** MAR-24 **Date:** 2026-04-24 **Status:** In Review Queue workers run Laravel queue jobs on deployed servers. S

Spec: Cron Jobs

**Issue:** MAR-25 **Date:** 2026-04-24 **Status:** In Review Cron jobs schedule recurring tasks on deployed servers. Shi

Spec: Daemons

**Issue:** MAR-26 **Date:** 2026-04-24 **Status:** In Review Daemons run persistent background processes on deployed ser

Spec: Deploy Scripts

**Issue:** MAR-32 **Date:** 2026-04-24 **Status:** In Review Deploy scripts define the bash commands that run on the ser

Spec: PHP Version

**Issue:** MAR-33 **Date:** 2026-04-24 **Status:** In Review PHP version management sets the PHP runtime version for a d

Spec: Repository Management

**Issue:** MAR-34 **Date:** 2026-04-24 **Status:** In Review Shipper installs a Git repository on a deployed site by cal

Spec: Network Rules

**Issue:** MAR-28 **Date:** 2026-04-23 **Status:** In Review Network rules manage firewall configurations per project, s

Spec: Nginx Configuration

**Issue:** MAR-29 **Date:** 2026-04-23 **Status:** In Review Nginx configuration management allows projects to specify r

Spec: Orphan Cleanup — PR Preview Environments

**Issue:** MAR-37 **Date:** 2026-04-24 **Status:** In Review Shipper deploys preview environments for pull requests usin

Spec: Plan/Apply Workflow

**Issue:** MAR-36 **Date:** 2026-04-23 **Status:** In Review The Plan/Apply workflow is the core operational pattern in

Spec: Ploi Provider

**Issue:** MAR-38 **Date:** 2026-04-23 **Status:** In Review The Ploi provider bridges Shipper's deployment pipeline to

Spec: Provider Architecture

**Issue:** MAR-20 **Date:** 2026-04-23 **Status:** In Review The Deployment module is the core of Shipper's mission — pr

Shipper CLI Specifications

![Shipper Banner](https://raw.githubusercontent.com/shippercli/assets/main/banner.png) Detailed specifications for Shipp

Spec: Redirect Rules

**Issue:** MAR-31 **Date:** 2026-04-23 **Status:** In Review Redirect rules define URL path redirections from a source p

Spec: Security Hardening — Path Traversal, Env Validation, Rate Limit Retry

**Date:** 2026-04-26 **Status:** Draft Three security/robustness issues found during codebase analysis that require fixe

Spec: Silent Failure Fixes — DB Deletion, Orphan Cleanup Errors

**Date:** 2026-04-26 **Status:** Draft Two issues where failures are silently ignored, making debugging difficult. **Fil

Spec: Site Lifecycle Management

**Issue:** MAR-21 **Date:** 2026-04-24 **Status:** In Review Shipper manages the complete lifecycle of sites on deployme

Spec: SSL Management

**Issue:** MAR-27 **Date:** 2026-04-23 **Status:** In Review SSL certificate management allows projects to enable HTTPS

Spec: Strict Type System

**Issue:** MAR-43 **Date:** 2026-04-23 **Status:** In Review Shipper enforces strict coding standards across the entire

Spec: Shipper Test Coverage Initiative

**Date:** 2026-04-26 **Status:** Draft Shipper has zero meaningful test coverage for its core components: provider manag

Spec: Variable Interpolation

**Issue:** MAR-42 **Date:** 2026-04-23 **Status:** In Review Variable interpolation allows database names and other iden