> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Laravel Boost custom agent for GitHub Copilot CLI

> A package that adds a custom agent for the GitHub Copilot CLI to Laravel Boost, with first-class Testbench support.

## Overview

`revolution/laravel-boost-copilot-cli` is a package that extends [Laravel Boost](https://github.com/laravel/boost) with a custom agent for the GitHub Copilot CLI.

Laravel Boost already ships with a `GitHub Copilot` agent, but that one is mainly aimed at the GitHub Copilot integration in VS Code. This package clarifies the path for the Copilot CLI and, in particular, provides a setup that plays nicely with package development that uses Testbench.

## Requirements

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

## Supported platforms

* macOS
* WSL (native Windows is also possible; WSL recommended)
* Linux

Laravel Sail is also usable. Run `vendor/bin/sail up -d` first, then run the `copilot` command outside of Sail.

## Installation

```shell theme={null}
composer require revolution/laravel-boost-copilot-cli --dev
```

## Usage

```shell theme={null}
php artisan boost:install
# Select "GitHub Copilot CLI"
copilot
```

Guidelines are generated as custom instructions at `.github/instructions/laravel-boost.instructions.md`.

The Copilot CLI automatically loads `.github/mcp.json` at the project root, so no additional configuration is required.

## Customization

Publish `config/boost.php` to change where the guidelines file and MCP configuration file are generated.

```shell theme={null}
php artisan vendor:publish --tag=boost-config
```

Add an `agents` entry to `config/boost.php`. To align the Copilot CLI with the official Copilot (VS Code) agent, point it at `AGENTS.md`. You can also change the Copilot (VS Code) side instead.

```php theme={null}
'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',
    ],
],
```

<Warning>
  `agents` is an undocumented feature and may change in future versions.
</Warning>

## Testbench support (for package developers)

This package provides a setup that makes Testbench-based workflows — which are hard to cover with the official Laravel Boost — easy to run.

<Steps>
  <Step title="Set up the Testbench workbench">
    ```shell theme={null}
    vendor/bin/testbench workbench:install
    ```
  </Step>

  <Step title="Add @build to composer.json">
    Add `@build` to `post-autoload-dump`.

    ```json theme={null}
    {
      "scripts": {
        "post-autoload-dump": [
          "@clear",
          "@prepare",
          "@build"
        ]
      }
    }
    ```
  </Step>

  <Step title="Install Boost via Testbench">
    ```shell theme={null}
    vendor/bin/testbench boost:install
    ```
  </Step>
</Steps>

## Related links

* GitHub: [invokable/laravel-boost-copilot-cli](https://github.com/invokable/laravel-boost-copilot-cli)
* Related package for PhpStorm: [invokable/laravel-boost-phpstorm-copilot](https://github.com/invokable/laravel-boost-phpstorm-copilot)
* Copilot SDK for Laravel: [invokable/laravel-copilot-sdk](https://github.com/invokable/laravel-copilot-sdk)


## Related topics

- [Creating a Custom Agent for Boost](/en/advanced/boost-custom-agent.md)
- [我的套件](/zh-TW/packages/index.md)
- [My Packages](/en/packages/index.md)
- [我的包](/zh-CN/packages/index.md)
- [Laravel Boost Custom Agent for PhpStorm with GitHub Copilot](/en/packages/laravel-boost-phpstorm-copilot.md)


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