 |
VOOZH | about |
|
VOOZH | about |
This document guides you through the initial setup of the revolution/laravel-boost-copilot-cli package, from installation to first use with GitHub Copilot CLI. It covers the core workflow of installing the package, generating MCP server configuration, and verifying the integration works correctly.
For detailed information about individual setup steps, see Installation, Configuration Generation, and Starting Copilot CLI. For environment-specific instructions (Laravel Sail, WSL, Orchestra Testbench), see Environment-Specific Setup.
The package requires the following components to be installed and configured:
| Component | Minimum Version | Purpose |
|---|---|---|
| PHP | 8.2 | Runtime environment |
| Laravel | 12.x | Framework foundation |
| Laravel Boost | 2.0 | MCP server and tools orchestration |
| GitHub Copilot CLI | 1.0 | AI assistant client |
Sources: README.md9-14
The package supports the following operating systems and environments:
Sources: README.md20-33
The following diagram illustrates the complete setup process from package installation to first Copilot CLI session:
Setup Process Flow
Sources: README.md35-61 Diagram 3 from high-level architecture
The following table maps the natural language concepts to their concrete implementation in the codebase:
| Concept | Code Entity | Location | Purpose |
|---|---|---|---|
| Agent Implementation | Revolution\LaravelBoostCopilotCli\CopilotCli | src/CopilotCli.php | Handles environment detection, path resolution, and MCP configuration generation |
| Service Registration | Revolution\LaravelBoostCopilotCli\CopilotCliServiceProvider | src/CopilotCliServiceProvider.php | Registers the agent with Laravel Boost framework |
| MCP Server Config | .github/mcp-config.json | Generated by boost:install | Tells Copilot CLI how to spawn the Laravel Boost MCP server |
| AI Guidelines | .github/instructions/laravel-boost.instructions.md | Generated from resources/views/agents/copilot-cli/guidelines/core.blade.php | Provides context-aware instructions to Copilot |
| Installation Command | boost:install | Provided by Laravel Boost | Interactive setup wizard |
| MCP Server Command | boost:mcp | Provided by Laravel Boost | Spawns the MCP server process |
Sources: README.md35-61 Diagram 1 and 5 from high-level architecture
Install the package via Composer as a development dependency:
This installs the package to vendor/revolution/laravel-boost-copilot-cli/ and registers CopilotCliServiceProvider with your Laravel application.
Sources: README.md37-39
Execute the Laravel Boost installation command:
The command presents two interactive prompts:
Feature Selection: Choose which Boost features to configure
AI Guidelines: Generates .github/instructions/laravel-boost.instructions.mdAgent Skills: Generates .github/skills/ directory with skill definitionsBoost MCP Server Configuration: Generates .github/mcp-config.json (required)Agent Selection: Choose which AI agents to configure
GitHub Copilot CLI to generate Copilot-specific configurationSources: README.md41-53
After successful installation, verify the following files exist:
| File Path | Generated When | Purpose |
|---|---|---|
.github/mcp-config.json | MCP Server Configuration selected | MCP server configuration for Copilot CLI |
.github/instructions/laravel-boost.instructions.md | AI Guidelines selected | Environment-specific AI context and guidelines |
.github/skills/*.md | Agent Skills selected | Reusable AI skill definitions (e.g., pest-testing) |
Sources: README.md46-48
The following diagram shows how the installed package components interact at runtime:
Runtime Component Architecture
Sources: README.md55-99 Diagram 4 from high-level architecture
After installation, start GitHub Copilot CLI with the generated MCP configuration:
The @ prefix tells Copilot CLI to load the configuration file from the current directory.
Verification: If the setup succeeded, you will see this message after Copilot starts:
Configured MCP servers: laravel-boost
Sources: README.md55-61
To avoid specifying --additional-mcp-config every time, add the following function to your .bashrc or .zshrc:
This function automatically loads both .github/mcp-config.json and .github/mcp-config.local.json if they exist in the current directory. After adding this function, reload your shell and use copilot normally:
Sources: README.md73-99
The CopilotCli class automatically detects your development environment and adjusts the MCP server command accordingly:
Environment-Specific Commands
| Environment | Detection Method | Generated Command | Config Location |
|---|---|---|---|
| Standard Laravel | Default | php artisan boost:mcp | .github/mcp-config.json |
| Laravel Sail | Docker running | ./vendor/bin/sail artisan boost:mcp | .github/mcp-config.json |
| WSL | Path contains /mnt/ | Converts Windows paths | .github/mcp-config.json |
| Orchestra Testbench | Testbench detected | ./vendor/bin/testbench boost:mcp | .github/mcp-config.json |
The environment detection logic is implemented in the CopilotCli::detectEnvironment() and related methods.
Sources: README.md27-33 docs/testbench.md55-78 Diagram 2 from high-level architecture
The following shows a complete setup from a fresh Laravel project:
Sources: README.md35-61
For MCP servers requiring sensitive credentials (API keys, tokens), create .github/mcp-config.local.json for local-only settings:
Example .github/mcp-config.local.json structure:
When using the copilot_mcp() shell function, both configuration files are loaded automatically if they exist.
Sources: README.md101-124
After completing the setup:
Sources: Table of contents structure
Refresh this wiki