Download the PHP package shippercli/cli without Composer
On this page you can find all versions of the php package shippercli/cli. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shippercli/cli
More information about shippercli/cli
Files in shippercli/cli
Package cli
Short Description A shipper application built with Laravel Zero with strict type checking
License MIT
Informations about the package cli
Shipper CLI
Declarative application deployments through a built-in provider and Composer provider plugins.
Shipper reads shipper.yml, validates the selected project and profile, shows
the planned operations, and delegates deployment work to the installed
provider package.
Install
Install globally with Composer:
Deployment Features
- ✅ Declarative YAML configuration (
shipper.yml) - ✅ Multiple projects and deployment profiles (production, staging, preview)
- ✅ Composer-discovered provider plugins through
shippercli/contracts - ✅ Plan/apply workflow for safe deployments
- ✅ Configuration validation
- ✅ GitHub Actions workflows for CI/CD
- ✅ Database configuration and automatic provisioning
- ✅ Database lifecycle management (create, link, destroy)
Or work from source:
Prebuilt PHAR binaries are published on the releases page.
Providers
Provider availability and lifecycle support currently differ by distribution:
| Provider | Distribution | Registered | Validate / plan | Apply | Destroy | Status / logs / rollback |
|---|---|---|---|---|---|---|
| Ploi | shippercli/provider-ploi Composer plugin |
When installed | Yes | Yes | Yes | Status and logs; no rollback |
| cPanel | shippercli/provider-cpanel Composer plugin |
When installed | Yes | Yes | Yes | Yes |
| Forge, Railway, Cloudflare Pages, Hostinger, Coolify, EasyPanel, Portainer | Experimental source only | No | Experimental | Unavailable | Unavailable | No |
Incomplete in-tree providers are deliberately not registered. Calling an
unimplemented lifecycle operation directly returns failure with a clear
not implemented error rather than reporting a successful deployment.
For local global use, install the CLI and providers into the same Composer
home, then run Composer's global vendor/bin/shipper:
Shipper discovers packages with Composer's runtime plugin metadata. Provider credentials, platform features, and configuration options belong to each provider's documentation rather than the core CLI.
The release PHAR has its own dependencies and cannot discover separately
installed provider packages. For CI, use
shippercli/actions/.github/actions/shipper@c2c276e12f831ba2c3377a063d579fede5cc5ecc, which installs the CLI and
providers together in an isolated Composer directory.
Configure
Create shipper.yml in the application repository:
provider_name is the slug registered by the installed package. Profiles can
override provider-supported runtime, database, domain, environment, and
lifecycle options.
Environment placeholders use ${NAME} syntax and are resolved at runtime.
Keep credentials in the shell, CI secrets, or another secret manager.
Commands
status, logs, and rollback are optional provider capabilities. Shipper
returns a clear error when the selected provider does not implement one.
Provider contracts
Every provider implements validation, planning, apply, destroy, name, and
error-reporting methods from shippercli/contracts.
Optional contracts add:
- deployment status
- recent logs
- release rollback
- server provisioning and cleanup
The CLI adapts installed contract providers to its internal flows. New providers are Composer plugins and are discovered from their package metadata.
GitHub Actions
A minimal deployment workflow installs Shipper and its provider packages in an isolated tool directory through the composite action:
See GitHub Actions for production, staging, preview, cleanup, and reusable-action patterns.
Documentation
- Documentation index
- Configuration
- Provider operations
- Server lifecycle
- Sites
- Databases
- PR previews
- GitHub Actions
-
Build and releases
- Configuration Guide - Complete shipper.yml configuration reference
- Server Lifecycle - Existing servers, managed preview servers, and cleanup rules
- PR Previews - Set up preview environments for pull requests
- Sites Management - Managing site lifecycle and deployment
- Database Management - Database configuration and operations
- GitHub Actions Setup - Automated deployments with GitHub Actions
- GitHub Action Usage - Using Shipper as a reusable GitHub Action
- Build System - Understanding the build and release process
- Strict Standards - Code quality and type safety standards
- Roadmap - Planned features and Ploi.io configurations not yet supported
Development
The codebase targets PHP 8.3+, Laravel Pint, PHPStan level 9, and Pest.
Release
Tags build and publish the PHAR through GitHub Actions:
License
MIT
All versions of cli with dependencies
php Version ^8.3
guzzlehttp/guzzle Version ^7.0
laravel-zero/framework Version ^12.1
laravel/forge-sdk Version ^3.25
ploi/ploi-php-sdk Version ^1.9
shippercli/contracts Version ^1.0
symfony/clock Version ^7.3
symfony/console Version ^7.3
symfony/string Version ^7.3
symfony/translation Version ^7.3
symfony/yaml Version ^7.0