Quickstart

Install Slipway, generate a config, compile provider YAML, and let the drift guard keep it honest.

Requirements

• PHP 8.3+
• Laravel 11, 12 or 13 (illuminate/console, illuminate/support, illuminate/contracts)
• For libraries (packages that are not Laravel apps): Orchestra Testbench

Get started

1. Install

   Install it as a dev dependency. The build artifact is produced with composer install --no-dev, so Slipway never ships to production.

   composer require --dev usamamuneerchaudhary/laravel-slipway
   
2. Create a config

   php artisan slipway:init                       # or --preset=deploy / --preset=package
   php artisan slipway:init --driver=github --driver=bitbucket
   

   Review the generated config/slipway.php. See presets and libraries if you are compiling a package rather than an app.

3. Compile and commit

   php artisan slipway:compile
   git add config/slipway.php .github .gitlab-ci.yml bitbucket-pipelines.yml
   

   slipway:compile writes the provider files. slipway:check fails if the committed YAML is stale — CI runs this for you.

Full command list: Commands. If a feature is not expressible on a provider, Slipway warns (or errors in strict mode) — see Provider support.