Laravel Boost Custom CodeEnvironment for GitHub Copilot CLI

Requirements

• PHP >= 8.3
• Laravel >= 12.x
• Laravel Boost >= 1.7
• Copilot CLI >= 0.0.343

Supported Platforms

• macOS
• WSL (Native Windows is not supported, please use laravel-boost-phpstorm-copilot)
• Linux

Laravel Sail

It also supports Laravel Sail. Before use, start it with vendor/bin/sail up -d. The copilot command runs outside of Sail.

Testbench for Package Developers

When developing Laravel packages, you can use Laravel Boost with Testbench.

Note: When using Testbench for package development, the environment differs from a regular Laravel project. Some MCP tools that depend on application-specific features (like database connections, specific models, or application routes) may not be available or may not work as expected in the Testbench environment.

Setup

First, ensure your testbench.yaml includes the following configuration:

env:
  CACHE_STORE: file

This is important because Laravel Boost requires a cache store to function properly.

Installation

Run the boost installation command using Testbench:

vendor/bin/testbench boost:install

This will generate .github/mcp-config.json configured for Testbench environment with the following settings:

{
    "mcpServers": {
        "laravel-boost": {
            "type": "local",
            "command": "./vendor/bin/testbench",
            "args": [
                "boost:mcp"
            ],
            "tools": [
                "*"
            ]
        }
    }
}

Usage

Use Copilot CLI with the generated config:

copilot --additional-mcp-config @.github/mcp-config.json

Installation

composer require revolution/laravel-boost-copilot-cli --dev

Usage

When you run the Laravel Boost installation command within your Laravel project, you'll see a GitHub Copilot CLI item added to the list. Select it to generate .github/mcp-config.json for Copilot CLI. To generate .github/copilot-instructions.md, also select the boost standard GitHub Copilot.

php artisan boost:install

When running the copilot command, specify .github/mcp-config.json using the --additional-mcp-config option.

copilot --additional-mcp-config @.github/mcp-config.json

If, after starting Copilot, Configured MCP servers: laravel-boost appears, the setup was successful.

From now on, always specify the --additional-mcp-config option when using the copilot command. It can be used together with other options.

copilot --additional-mcp-config @.github/mcp-config.json --resume

copilot --additional-mcp-config @.github/mcp-config.json --continue

License

MIT