> ## 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 GitHub Copilot CLI agent to Laravel Boost, with strong Testbench support.

## Overview

`revolution/laravel-boost-copilot-cli` adds a custom GitHub Copilot CLI agent as an extension for [Laravel Boost](https://github.com/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+

## Supported platforms

* 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

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

## Usage

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

The guidelines will be generated as custom instructions in `.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`.

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

Add an `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.

```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 a future release.
</Warning>

## 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.

<Steps>
  <Step title="Set up 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 through 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)