README

Trigger and monitor ShipIt deployments straight from your Laravel app's Artisan console.

php artisan shipit:deploy --watch

Drop it into any Laravel project, point it at a ShipIt site, and deploy from your terminal or CI pipeline — --watch streams the live log and exits non-zero if the deployment fails, so it gates a pipeline cleanly.

Requirements

• PHP 8.2+
• Laravel 11, 12, or 13

Installation

composer require sydgren/laravel-shipit

The service provider is auto-discovered. Optionally publish the config:

php artisan vendor:publish --tag=shipit-config

Configuration

Configure via environment variables (no published config needed):

SHIPIT_TOKEN=your-personal-access-token
SHIPIT_SITE=example.com          # site id or domain this project deploys to
SHIPIT_URL=https://shipit.henriknordquist.dk   # only if self-hosted elsewhere

Create a token in ShipIt under Settings → API tokens. SHIPIT_SITE is the default site every command targets when you don't pass one explicitly — set it once per project and php artisan shipit:deploy just works.

Commands

{site} accepts either a numeric ShipIt id or a domain/name. When omitted, commands fall back to SHIPIT_SITE.

Examples

# Deploy the configured site and watch the log (exits non-zero on failure)
php artisan shipit:deploy --watch

# Deploy a specific branch of a specific site, don't block
php artisan shipit:deploy example.com --branch=staging --no-wait

# Tail the latest deployment's log
php artisan shipit:logs --watch

# Roll back
php artisan shipit:deployments      # find the id of a good release
php artisan shipit:rollback 1234

In CI (GitHub Actions)

- name: Deploy
  run: php artisan shipit:deploy --watch
  env:
    SHIPIT_TOKEN: ${{ secrets.SHIPIT_TOKEN }}
    SHIPIT_SITE: ${{ vars.SHIPIT_SITE }}

Programmatic use

The ShipIt facade exposes the same API client the commands use:

use Sydgren\ShipIt\Facades\ShipIt;

$siteId = ShipIt::resolveSiteId('example.com');
$deployment = ShipIt::deploy($siteId, branch: 'main')['deployment'];
$status = ShipIt::output($deployment['id'])['status'];

Testing

composer install
vendor/bin/pest

License

MIT