Getting Started

This page walks through the first successful deployment flow.

Install

composer require ulties/shipper

Create a First Configuration

providers:
  hosting:
    api_key: "${HOSTING_API_KEY}"

projects:
  api:
    provider: hosting
    profiles:
      production:
        branch: main
        domain: "api.example.com"

Provider-specific keys belong on the provider pages:

• Ploi
• Laravel Forge
• cPanel
• EasyPanel

Run the CLI in Order

1. Validate the configuration
2. Plan the deployment
3. Apply the deployment

Validate

php shipper validate

Plan

php shipper plan --project api --profile production

Apply

php shipper apply --project api --profile production

Failure Modes

• missing provider credentials: set the required environment variables for the chosen provider
• unknown provider key: ensure projects.<name>.provider matches a key under providers
• incomplete profile: add at least the branch and domain for the first environment

Read Next

• Concepts
• Configuration Reference
• GitHub Actions Workflows