跳转到主要内容

概览

revolution/laravel-boost-copilot-cliLaravel Boost 的扩展包,用来为 GitHub Copilot CLI 增加自定义 agent。 Laravel Boost 本体也有 GitHub Copilot,但那主要面向 VS Code 的 GitHub Copilot 集成。本包则明确面向 Copilot CLI,特别是在使用 Testbench 的包开发场景中提供更易用的结构。

环境要求

  • PHP 8.2+
  • Laravel 12+
  • Laravel Boost 2.0+
  • Copilot CLI 1.0.61+

支持平台

  • macOS
  • WSL(也支持原生 Windows,推荐使用 WSL)
  • Linux
也可以在 Laravel Sail 中使用。请先执行 vendor/bin/sail up -d,然后在 Sail 外部执行 copilot 命令。

安装

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

用法

php artisan boost:install
# 选择 "GitHub Copilot CLI"
copilot
指南会作为自定义 instructions 生成到 .github/instructions/laravel-boost.instructions.md Copilot CLI 会自动读取项目根目录下的 .github/mcp.json,因此不需要额外配置。

自定义

发布 config/boost.php 后,可以修改指南文件和 MCP 配置文件的生成路径。
php artisan vendor:publish --tag=boost-config
config/boost.php 中添加 agents。要让 Copilot CLI 与官方 Copilot(VS Code)保持一致,可以指定 AGENTS.md。反过来,也可以修改 Copilot(VS Code)一侧。
'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 是文档中未记载的功能,未来版本升级中可能会发生变化。

Testbench 支持(面向包开发者)

本包提供了一种更易适配基于 Testbench 的运营方式,弥补 Laravel Boost 官方难以覆盖的场景。
1

搭建 Testbench 的 workbench

vendor/bin/testbench workbench:install
2

在 composer.json 中添加 @build

post-autoload-dump 中添加 @build
{
  "scripts": {
    "post-autoload-dump": [
      "@clear",
      "@prepare",
      "@build"
    ]
  }
}
3

通过 Testbench 安装 Boost

vendor/bin/testbench boost:install

相关链接

最后修改于 2026年7月13日