> ## Documentation Index
> Fetch the complete documentation index at: https://laravel-slipway.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](https://github.com/orchestral/testbench)

## Get started

<Steps>
  <Step title="Install">
    Install it as a **dev** dependency. The build artifact is produced with `composer install --no-dev`, so Slipway never ships to production.

    ```bash theme={null}
    composer require --dev usamamuneerchaudhary/laravel-slipway
    ```
  </Step>

  <Step title="Create a config">
    ```bash theme={null}
    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](/presets-and-libraries) if you are compiling a package rather than an app.
  </Step>

  <Step title="Compile and commit">
    ```bash theme={null}
    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.
  </Step>
</Steps>

<Tip>
  Full command list: [Commands](/commands). If a feature is not expressible on a provider, Slipway warns (or errors in `strict` mode) — see [Provider support](/provider-support).
</Tip>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.