VOOZH about

URL: https://deepwiki.com/invokable/laravel-boost-copilot-cli/7-reference

⇱ Reference | invokable/laravel-boost-copilot-cli | DeepWiki


Loading...
Last indexed: 7 March 2026 (397730)
Menu

Reference

This section provides quick-reference material for the revolution/laravel-boost-copilot-cli package: its dependencies, configuration files, Artisan and Composer commands, troubleshooting guidance, version control configuration, and license. For conceptual explanations of how these pieces fit together, see Core Architecture and Configuration System.


Section Map

PageTitleWhat You'll Find
7.1Package DependenciesRuntime and dev dependency list with version constraints
7.2Configuration Files ReferenceEvery config file in the repo described in one place
7.3Command ReferenceAll Artisan commands, Composer scripts, and copilot invocations
7.4TroubleshootingKnown issues, workarounds, and environment-specific fixes
7.5Version Control Configuration.gitattributes export-ignore rules and .gitignore entries
7.6LicenseMIT license terms and copyright

Key Code Entities at a Glance

Primary source files

SymbolFileRole
CopilotClisrc/CopilotCli.phpCore agent class; implements Agent, SupportsGuidelines, SupportsMcp, SupportsSkills interfaces
CopilotCliServiceProvidersrc/CopilotCliServiceProvider.phpRegisters the agent via Boost::registerAgent() and fixes Testbench root path
core.blade.phpresources/boost/guidelines/core.blade.phpGuideline template distributed to package users via boost:install
copilot-cli.blade.php.ai/guidelines/copilot-cli.blade.phpGuideline template used during package development

Generated output files

FileCreated ByPurpose
.github/mcp-config.jsonboost:installMCP server configuration: defines mcpServers.laravel-boost with command, args, and tools
.github/mcp-config.local.jsonDeveloper (manual)Local-only credentials, never committed (in .gitignore)
.github/instructions/laravel-boost.instructions.mdboost:installAI guideline instructions for Copilot CLI, rendered from core.blade.php
.github/skills/pest-testing/SKILL.mdboost:installPest testing agent skill definition
.github/copilot-instructions.mdDeveloper (manual/workaround)Workaround for Copilot CLI < character parser bug
boost.jsonboost:installRecords selected agents, skills, and feature flags

Sources: src/CopilotCli.php src/CopilotCliServiceProvider.php resources/boost/guidelines/core.blade.php .ai/guidelines/copilot-cli.blade.php


Component Relationship Diagram

Diagram: Key Code Entities and Their Relationships


Sources: src/CopilotCli.php src/CopilotCliServiceProvider.php </old_str> <new_str>

Component Relationship Diagram

Diagram: Key Code Entities and Their Relationships


Sources: src/CopilotCli.php src/CopilotCliServiceProvider.php


Component Relationship Diagram

Diagram: Key Code Entities and Their Relationships


Sources: src/CopilotCli.php src/CopilotCliServiceProvider.php README.md1-133


Command Summary

A full reference with all options appears in 7.3 Command Reference. The most frequently used commands:

CommandContextEffect
composer require revolution/laravel-boost-copilot-cli --devShellInstalls the package
php artisan boost:installLaravel appGenerates .github/ config files interactively
vendor/bin/testbench boost:installPackage devGenerates config files for Testbench environment
copilot --additional-mcp-config @.github/mcp-config.jsonShellStarts Copilot CLI with MCP server attached
composer testShellRuns pest --compact test suite
composer lintShellRuns pint code formatter
composer boostPackage devRuns vendor/bin/testbench boost:install --no-interaction --ansi
composer buildPackage devRuns vendor/bin/testbench workbench:build --ansi

Composer Scripts Reference

The package defines several Composer scripts for development workflow. These are defined in composer.json53-76:

ScriptComposer CommandActual CommandPurpose
testcomposer testpest --compactRun Pest test suite with compact output
test:coveragecomposer test:coveragepest --compact --coverage --coverage-clover build/logs/clover.xmlRun tests with coverage report
lintcomposer lintpintFormat code with Laravel Pint
test:lintcomposer test:lintpint --testCheck code formatting without changes
boostcomposer boostvendor/bin/testbench boost:install --no-interaction --ansiRun boost:install in Testbench non-interactively
clearcomposer clearvendor/bin/testbench package:purge-skeleton --ansiPurge package skeleton files
preparecomposer preparevendor/bin/testbench package:discover --ansiDiscover packages
buildcomposer buildvendor/bin/testbench workbench:build --ansiBuild workbench environment
servecomposer servevendor/bin/testbench serve --ansiStart Testbench development server
post-autoload-dump(automatic)@clear, @prepare, @buildAutomatically runs after composer dump-autoload

Sources: composer.json53-76


MCP Server Config Structure (Quick Reference)

A full description of each field is in 7.2 Configuration Files Reference. The core structure written by CopilotCli::mcpServerConfig():

.github/mcp-config.json
└── mcpServers
 └── laravel-boost
 ├── type → "local"
 ├── command → "php" | "./vendor/bin/sail" | "./vendor/bin/testbench"
 ├── args → ["artisan", "boost:mcp"] or ["boost:mcp"]
 ├── env → {} (may include TESTBENCH_CORE for Testbench)
 └── tools → ["*"]

The command value is determined by CopilotCli::convertCommandToPhpPath() based on the detected environment. See 5.4 Environment Detection and Adaptation for the full decision tree.


Environment Detection Quick Reference

Condition CheckedDetection MethodImplementationResult
TESTBENCH_CORE constant defineddefined('TESTBENCH_CORE') in isRunningInTestbench()src/CopilotCli.phpCommand: ./vendor/bin/testbench, Args: ['boost:mcp'], Env: ['TESTBENCH_CORE' => '1']
WSL_DISTRO_NAME or IS_WSL env var setgetenv('WSL_DISTRO_NAME') or getenv('IS_WSL') in isRunningInsideWsl()src/CopilotCli.phpUses getPhpPath() from base Agent class (converts to Windows path)
Command string ends with 'sail'str_ends_with($command, 'sail') checksrc/CopilotCli.phpCommand: ./vendor/bin/sail, Args: ['artisan', 'boost:mcp']
None of the aboveDefault casesrc/CopilotCli.phpCommand: as-is (e.g. php), Args: ['artisan', 'boost:mcp']

Environment-specific MCP config examples:


Sources: src/CopilotCli.php


Diagram: Command-to-File Resolution

Diagram: How boost:install Resolves to Output Files


Sources: README.md43-53 src/CopilotCli.php


For in-depth explanations of any of these topics, navigate to the relevant child page using the section map at the top of this page.