Overview
revolution/laravel-boost-copilot-cli adds a custom GitHub Copilot CLI agent as an extension for Laravel Boost.
Laravel Boost already includes GitHub Copilot, but that path is mainly oriented to VS Code GitHub Copilot workflows. This package gives you a clearer setup for Copilot CLI and is especially useful for package developers using Testbench.
Requirements
- PHP 8.2+
- Laravel 12+
- Laravel Boost 2.0+
- Copilot CLI 1.0.61+
- macOS
- WSL (Native Windows also works, but WSL is recommended)
- Linux
Laravel Sail is also supported. Run vendor/bin/sail up -d first, then execute the copilot command outside Sail.
Installation
composer require revolution/laravel-boost-copilot-cli --dev
Usage
php artisan boost:install
# Select "GitHub Copilot CLI"
copilot
.github/instructions/laravel-boost.instructions.md.
Copilot CLI automatically loads .github/mcp.json from your project root, so you do not need extra configuration.
Customization
You can change the path where the guidelines file is generated by publishing config/boost.php.
php artisan vendor:publish --tag=boost-config
agents key to config/boost.php. To align Copilot CLI with the official Copilot (VS Code) agent, specify AGENTS.md. You can also update the Copilot (VS Code) side instead.
'executable_paths' => [],
'agents' => [
// Copilot CLI
'copilot_cli' => [
'guidelines_path' => 'AGENTS.md',
'mcp_config_path' => '.github/mcp.json',
],
// Copilot(VS Code)
'copilot' => [
'guidelines_path' => '.github/instructions/laravel-boost.instructions.md',
'mcp_config_path' => '.vscode/mcp.json',
],
],
agents is an undocumented feature and may change in a future release.
Testbench support (for package developers)
This package is designed to work smoothly in Testbench-based package development workflows where Laravel Boost defaults can be harder to apply directly.
Set up Testbench workbench
vendor/bin/testbench workbench:install
Add @build to composer.json
Add @build to post-autoload-dump.{
"scripts": {
"post-autoload-dump": [
"@clear",
"@prepare",
"@build"
]
}
}
Install Boost through Testbench
vendor/bin/testbench boost:install
