README

English | 繁體中文 | 简体中文

Introduction

A Laravel Composer package that provides Windsurf integration for Laravel Boost.

Requirements

• PHP 8.1 or higher
• Laravel 10.0 or higher
• Laravel Boost 1.4 or higher
• Windsurf Editor or Windsurf JetBrains Plugin

Installation

Step 1: Install the Package

Install the package via Composer as a development dependency:

composer require gonetone/laravel-boost-windsurf-extension --dev

Step 2: Install Laravel Boost

Laravel Boost will auto-detect the Windsurf installation automatically. Run the command below to install Laravel Boost follow the installation instructions. More information can be found in the Laravel Boost documentation.

php artisan boost:install

During installation, you will be prompted to select an environment. The available options will include the following two:

• windsurf - For Windsurf Editor
• windsurf_jetbrains_plugin - For Windsurf JetBrains Plugin (PhpStorm, etc.)

Switching Between Projects

Since Windsurf only supports global-level MCP configuration files and does not have project-level MCP configuration files, you need to run the following command to update the MCP configuration when switching between different Laravel projects:

php artisan boost:install --no-interaction

This ensures that Windsurf MCP configuration points to the correct path for the current project.

License

Laravel Boost - Windsurf Extension is open-sourced software licensed under the MIT license.