Laravel Boost

https://github.com/laravel/boost
Admin
Laravel Boost accelerates AI-assisted development by providing essential context and structure for...
Tokens:139,274
Snippets:983
Trust Score:9.7
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install Command Usage Examples

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-InstallCommand.md

Shows three ways to run the boost:install command: fully interactive, unattended with guidelines, and MCP configuration only. The --no-interaction flag enables unattended mode, and --guidelines installs guidelines with the stored agent list.

```bash
# Fully interactive
php artisan boost:install
```

```bash
# Unattended — install guidelines with the stored agent list
php artisan boost:install --no-interaction --guidelines
```

```bash
# Install MCP configuration only
php artisan boost:install --mcp
```

--------------------------------

### Usage examples for boost:add-skill command

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-AddSkillCommand.md

Shows various ways to invoke the artisan command: interactive, direct from repo spec, full URL with list mode, and install everything with overwrite and skip audit.

```bash
# Interactive
php artisan boost:add-skill

# Direct from repo spec
php artisan boost:add-skill vercel-labs/agent-skills

# Full URL, list mode
php artisan boost:add-skill https://github.com/owner/repo --list

# Install everything, overwrite, skip audit
php artisan boost:add-skill owner/repo --all --force --skip-audit
```

--------------------------------

### performInstallation(): void method

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-InstallCommand.md

Installs selected features (guidelines, skills, MCP) and stores configuration. Uses the built GuidelineConfig instance and checks selectedBoostFeatures to conditionally run each installation step.

```php
app()->instance(GuidelineConfig::class, $this->buildGuidelineConfig());

if ($this->selectedBoostFeatures->contains('guidelines')) {
    $this->installGuidelines();
}

if ($this->selectedBoostFeatures->contains('skills')) {
    $this->installSkills();
}

if ($this->selectedBoostFeatures->contains('mcp')) {
    $this->installMcpServerConfig();
}

$this->storeConfig();
```

--------------------------------

### boost:update usage examples

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-OtherCommands.md

Shows three usage variants: default discovery, skipping discovery with --no-discover, and skipping skills with --ignore-skills.

```bash
php artisan boost:update              # discover + update
php artisan boost:update --no-discover
php artisan boost:update --ignore-skills
```

--------------------------------

### MCP Configuration Installation Methods

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Agents.md

Demonstrates how to write MCP configuration through the agent's contract methods, including standard and HTTP-based MCP installation.

```APIDOC
## MCP Installation Methods

### Description
Install MCP (Model Context Protocol) configuration for the agent using either a command-based or HTTP-based approach.

### Methods
- **installMcp(string $key, string $command, array $args)** - Installs an MCP server configuration with the given key, command, and arguments. Returns a boolean indicating success.
- **installHttpMcp(string $key, string $url)** - Installs an HTTP-based MCP server configuration with the given key and URL. Returns a boolean indicating success.

### Example
```php
$ok = $agent->installMcp(
    key: 'laravel-boost',
    command: $agent->getPhpPath(),
    args: [$agent->getArtisanPath(), 'boost:mcp'],
);

$okHttp = $agent->installHttpMcp('nightwatch', 'https://nightwatch.laravel.com/mcp');
```
```

--------------------------------

### Silent installer call in handle

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-OtherCommands.md

Re-runs the installer silently with --no-interaction, passing the guidelines and skills flags. This is part of the update workflow after discovery.

```php
$this->callSilently(InstallCommand::class, [
    '--no-interaction' => true,
    '--guidelines' => $guidelines,
    '--skills' => $hasSkills,
]);
```

--------------------------------

### Programmatic Invocation with Artisan Facade

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-InstallCommand.md

Calls the boost:install command programmatically using the Artisan facade, passing the --guidelines and --no-interaction options as an array. Useful for integrating the install process into custom scripts or tests.

```php
use Illuminate\Support\Facades\Artisan;

Artisan::call('boost:install', ['--guidelines' => true, '--no-interaction' => true]);
```

--------------------------------

### handle(): int method

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-InstallCommand.md

Main entry point for the install command. Flushes skill parse failures, initializes terminal dimensions, and runs the installation workflow. Returns exit code 0 on success; failures within per-agent processing are reported but do not abort the command.

```php
public function handle(): int
{
    app(SkillParseFailures::class)->flush();

    $this->terminal->initDimensions();
    $this->projectName = config('app.name');

    $this->displayBoostHeader('Install', $this->projectName);
    $this->discoverEnvironment();
    $this->collectInstallationPreferences();
    $this->performInstallation();

    $this->reportRenderFailures();
    $this->reportSkillParseFailures();

    $this->noteInferConventions();

    $this->outro();

    return self::SUCCESS;
}
```

--------------------------------

### Sail::isInstalled()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Checks if Sail is installed by verifying the binary exists and a compose file is present. Returns a boolean indicating installation status.

```APIDOC
## Sail::isInstalled()

### Description
Checks if Sail is installed by verifying the binary exists and a compose file is present. Returns a boolean indicating installation status.

### Method
Instance method

### Signature
`isInstalled(): bool`

### Returns
- **bool** - `true` if the binary exists (at `binaryPath()` or `base_path(binaryPath())`) and a compose file exists (`compose.yml`, `compose.yaml`, `docker-compose.yml`, `docker-compose.yaml`); otherwise `false`.

### Example
```php
$sail = app(\Laravel\Boost\Install\Sail::class);
$installed = $sail->isInstalled();
```
```

--------------------------------

### Run boost:mcp command

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-OtherCommands.md

Executes the `boost:mcp` Artisan command to start Laravel Boost, typically from `mcp.json`.

```bash
php artisan boost:mcp
```

--------------------------------

### Usage example for SkillWriter write and sync methods

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Skills.md

Shows how to instantiate SkillWriter with a Pi agent and call write() and sync(). The write() method returns an integer status (0=SUCCESS, 1=UPDATED, 2=FAILED). The sync() method returns an array of statuses keyed by skill name, and the example iterates over them to echo failures.

```php
use Laravel\Boost\Install\SkillWriter;
use Laravel\Boost\Install\Agents\Pi;

$writer = new SkillWriter(app(\Laravel\Boost\Install\Agents\Pi::class));

$result = $writer->write($skill);
// 0 = SUCCESS, 1 = UPDATED, 2 = FAILED

$results = $writer->sync($skillsCollection, $previouslyTrackedSkillNames);
foreach ($results as $name => $status) {
    if ($status === SkillWriter::FAILED) {
        echo "Failed to sync {$name}".PHP_EOL;
    }
}
```

--------------------------------

### Registering a Custom Agent

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Boost.md

Example from UPGRADE.md showing registerAgent usage in a service provider.

```php
// In a service provider.
use Laravel\Boost\Boost;
use Laravel\Boost\Install\Agents\Agent;

Boost::registerAgent('my_agent', App\Agents\MyAgent::class);
```

--------------------------------

### FileWriter usage example

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-McpWriter.md

Shows how to instantiate FileWriter and use the fluent API to add a server config and save. The example targets a .cursor/mcp.json file and uses the 'laravel-boost' server key.

```php
use Laravel\Boost\Install\Mcp\FileWriter;

$writer = new FileWriter(base_path('.cursor/mcp.json'), ['$schema' => '...']);

$ok = $writer
    ->configKey('mcpServers')
    ->addServerConfig('laravel-boost', [
        'command' => PHP_BINARY,
        'args' => [base_path('artisan'), 'boost:mcp'],
    ])
    ->save();
```

--------------------------------

### Sail::binCommand()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Builds a Sail bin command string using the configured binary path. Returns the command as a string.

```APIDOC
## Sail::binCommand()

### Description
Builds a Sail bin command string using the configured binary path. Returns the command as a string.

### Method
Static method

### Signature
`binCommand(): string`

### Returns
- **string** - The command string `{binaryPath()} bin `

### Example
```php
$command = Sail::binCommand();
```
```

--------------------------------

### McpWriter::installNightwatchMcp

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-McpWriter.md

Installs the Nightwatch MCP server configuration via the agent's HTTP MCP installation method. Throws a RuntimeException if installation fails.

```APIDOC
## `McpWriter::installNightwatchMcp(Nightwatch $nightwatch): void`

### Description
Installs the Nightwatch MCP server configuration via the agent's HTTP MCP installation method. Throws a RuntimeException if installation fails.

### Method
`installNightwatchMcp`

### Parameters
- `$nightwatch` (Nightwatch) - Required - Nightwatch instance providing the MCP URL.

### Throws
- `RuntimeException` - If installation fails, with message "Failed to install Nightwatch MCP: could not write configuration".
```

--------------------------------

### Usage example for TomlFileWriter

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-McpWriter.md

Shows how to instantiate TomlFileWriter and use the fluent API to add a server config and save it to a TOML file.

```php
use Laravel\Boost\Install\Mcp\TomlFileWriter;

$writer = new TomlFileWriter(base_path('.codex/config.toml'));

$ok = $writer
    ->configKey('mcp_servers')
    ->addServerConfig('laravel-boost', [
        'command' => PHP_BINARY,
        'args' => [base_path('artisan'), 'boost:mcp'],
        'env' => ['APP_ENV' => 'local'],
    ])
    ->save();
```

```toml
[mcp_servers.laravel-boost]
command = "/usr/bin/php"
args = ["/app/artisan", "boost:mcp"]

[mcp_servers.laravel-boost.env]
APP_ENV = "local"
```

--------------------------------

### Sail::binaryPath()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Returns the configured Sail binary path, or the default path if not configured. Returns the binary path as a string.

```APIDOC
## Sail::binaryPath()

### Description
Returns the configured Sail binary path, or the default path if not configured. Returns the binary path as a string.

### Method
Static method

### Signature
`binaryPath(): string`

### Returns
- **string** - The binary path, either from `config('boost.executable_paths.sail')` or the default `vendor/bin/sail`.

### Example
```php
$path = Sail::binaryPath();
```
```

--------------------------------

### RuleComposer class constructor

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Defines the RuleComposer class with a constructor that injects a GuidelineComposer instance. Used to compose managed rules for installation.

```php
class RuleComposer
{
    public function __construct(protected GuidelineComposer $guidelines) {}
}
```

--------------------------------

### Frontmatter example

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Rules.md

Example YAML frontmatter with paths globs used in rule files.

```markdown
---
paths:
  - app/Http/Controllers/**
  - app/Services/*
---
```

--------------------------------

### Run boost:list-skills command

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-OtherCommands.md

Executes the `boost:list-skills` Artisan command to list all available skills in the current project.

```bash
php artisan boost:list-skills
```

--------------------------------

### Sail::composerCommand()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Builds a Sail composer command string using the configured binary path. Returns the command as a string.

```APIDOC
## Sail::composerCommand()

### Description
Builds a Sail composer command string using the configured binary path. Returns the command as a string.

### Method
Static method

### Signature
`composerCommand(): string`

### Returns
- **string** - The command string `{binaryPath()} composer`

### Example
```php
$command = Sail::composerCommand();
```
```

--------------------------------

### Agent::fromName usage example

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Agents.md

Shows how to use the static fromName method to retrieve an Agent instance by its registry key, returning null when not found.

```php
use Laravel\Boost\Install\Agents\Agent;

$agent = Agent::fromName('pi');       // ?Agent
$agent = Agent::fromName('nope');     // null
```

--------------------------------

### Sail::artisanCommand()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Builds a Sail artisan command string using the configured binary path. Returns the command as a string.

```APIDOC
## Sail::artisanCommand()

### Description
Builds a Sail artisan command string using the configured binary path. Returns the command as a string.

### Method
Static method

### Signature
`artisanCommand(): string`

### Returns
- **string** - The command string `{binaryPath()} artisan`

### Example
```php
$command = Sail::artisanCommand();
```
```

--------------------------------

### Run boost:index-rules command

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-OtherCommands.md

Executes the `boost:index-rules` Artisan command to regenerate the project rules index.

```bash
php artisan boost:index-rules
```

--------------------------------

### Using AgentsDetector to discover installed agents

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Detection.md

Shows how to use the AgentsDetector to discover system-installed and project-installed agents.

```php
use Laravel\Boost\Install\AgentsDetector;

$detector = app(AgentsDetector::class);

$system = $detector->discoverSystemInstalledAgents();
$project = $detector->discoverProjectInstalledAgents(base_path());
```

--------------------------------

### Sail class with default binary path constant

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Defines the Sail class with a constant for the default binary path. Used by the installer to locate the Sail binary.

```php
class Sail
{
    public const DEFAULT_BINARY_PATH = 'vendor'.DIRECTORY_SEPARATOR.'bin'.DIRECTORY_SEPARATOR.'sail';
}
```

--------------------------------

### Update boost:install command flags to positive opt-in

Source: https://github.com/laravel/boost/blob/main/UPGRADE.md

The boost:install command flags have changed from negative opt-out to positive opt-in. Use the new flags to enable guidelines, skills, and MCP.

```diff
- php artisan boost:install {--ignore-guidelines} {--ignore-mcp}
+ php artisan boost:install {--guidelines} {--skills} {--mcp}
```

--------------------------------

### StartCommand class with AsCommand attribute

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-OtherCommands.md

Defines the `boost:mcp` command using the `AsCommand` attribute. Its handle method forwards to `mcp:start` with the `laravel-boost` server name.

```php
#[AsCommand('boost:mcp', 'Starts Laravel Boost (usually from mcp.json)')]
class StartCommand extends Command
{
    public function handle(): int
    {
        return Artisan::call('mcp:start laravel-boost');
    }
}
```

--------------------------------

### GuidelineAssist::nodePackageManagerCommand()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-GuidelineAssist.md

Returns the command for the node package manager (e.g., 'npm install'), honoring configured executable paths and Sail when enabled.

```APIDOC
## nodePackageManagerCommand(string $command)

### Description
Returns the command for the node package manager (e.g., 'npm install'), honoring configured executable paths and Sail when enabled.

### Method
nodePackageManagerCommand(string $command)

### Parameters
- **$command** (string) - Required - The command to run (e.g., 'install').

### Return Type
string
```

--------------------------------

### Sail::command(string $command)

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Builds a Sail command string using the configured binary path and the given command. Returns the command as a string.

```APIDOC
## Sail::command(string $command)

### Description
Builds a Sail command string using the configured binary path and the given command. Returns the command as a string.

### Method
Static method

### Signature
`command(string $command): string`

### Parameters
- **$command** (string) - Required - The command to run via Sail.

### Returns
- **string** - The command string `{binaryPath()} {command}`

### Example
```php
$command = Sail::command('artisan migrate');
```
```

--------------------------------

### Sail::buildMcpCommand(string $serverName)

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Builds an MCP command array for the given server name. Returns an associative array with key, command, and args.

```APIDOC
## Sail::buildMcpCommand(string $serverName)

### Description
Builds an MCP command array for the given server name. Returns an associative array with key, command, and args.

### Method
Instance method

### Signature
`buildMcpCommand(string $serverName): array{key: string, command: string, args: array<int, string>}`

### Parameters
- **$serverName** (string) - Required - The name of the MCP server.

### Returns
- **array{key: string, command: string, args: array<int, string>}** - An array with `key` set to `$serverName`, `command` set to `binaryPath()`, and `args` set to `['artisan', 'boost:mcp']`.

### Example
```php
$sail = app(\Laravel\Boost\Install\Sail::class);
$mcpCommand = $sail->buildMcpCommand('my-server');
```
```

--------------------------------

### CommandNormalizer::normalize usage example

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Support.md

Example call to CommandNormalizer::normalize with a command string and additional args. Returns an array with the command and args, preserving absolute paths.

```php
CommandNormalizer::normalize('php -d memory_limit=1G artisan', ['boost:mcp']);
// ['command' => 'php', 'args' => ['-d', 'memory_limit=1G', 'artisan', 'boost:mcp']]
```

--------------------------------

### ListSkillCommand signature and description

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-OtherCommands.md

Defines the `boost:list-skills` command signature and description. Used to list all available skills in the current project.

```php
protected $signature = 'boost:list-skills';
protected $description = 'List all available skills in the current project';
```

--------------------------------

### Example browser log output

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/BrowserLogging.md

Shows the resulting log entry format written to the 'browser' channel, including URL, user agent, and timestamp.

```text
[2025-01-01 00:00:00] local.ERROR: ... {"url":"http://localhost/","user_agent":"...","timestamp":"..."}
```

--------------------------------

### GuidelineAssist::supportsPintAgentFormatter()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-GuidelineAssist.md

Checks whether the project's PHP setup supports the Pint agent formatter, specifically requiring Pint version >= 1.27.0. Returns true if supported.

```APIDOC
## supportsPintAgentFormatter()

### Description
Checks whether the project's PHP setup supports the Pint agent formatter, specifically requiring Pint version >= 1.27.0. Returns true if supported.

### Method
supportsPintAgentFormatter()

### Return Type
bool
```

--------------------------------

### ApplicationInfo handle() JSON response

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Mcp-ResourcesAndPrompts.md

Example JSON response returned by the ApplicationInfo resource's handle() method. Shows the structure with php_version, laravel_version, database_engine, and packages array.

```json
{
  "php_version": "8.4",
  "laravel_version": "11.45.3",
  "database_engine": "mysql",
  "packages": [
    { "roster_name": "LARAVEL_FRAMEWORK", "version": "11.45.3", "package_name": "laravel/framework" }
  ]
}
```

--------------------------------

### Skill file frontmatter example

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Skills.md

Shows the required Markdown frontmatter for a skill file, including name and description fields. The frontmatter must define both name and description or the skill is skipped.

```markdown
---
name: infer-conventions
description: Record your app conventions and sharpen code generation.
---

Instructions...
```

--------------------------------

### Using RuleFrontmatter::parse

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Rules.md

Example usage of the static parser to destructure paths and body from Markdown content with YAML frontmatter.

```php
use Laravel\Boost\Rules\RuleFrontmatter;

['paths' => $paths, 'body' => $body] = RuleFrontmatter::parse($markdownContent);
```

--------------------------------

### GuidelineWriter usage example

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-GuidelineComposer.md

Instantiates GuidelineWriter with a ClaudeCode agent and writes composed guidelines, then matches the result to output a message for NEW, REPLACED, or NOOP outcomes.

```php
use Laravel\Boost\Install\GuidelineWriter;
use Laravel\Boost\Install\Agents\ClaudeCode;

$writer = new GuidelineWriter(app(\Laravel\Boost\Install\Agents\ClaudeCode::class));
$result = $writer->write($composedGuidelines);

match ($result) {
    GuidelineWriter::NEW => $this->info('Created guidelines file.'),
    GuidelineWriter::REPLACED => $this->info('Updated existing guidelines block.'),
    GuidelineWriter::NOOP => $this->info('Nothing to write.'),
};
```

--------------------------------

### MarkdownFormatter class with static format method

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Provides a static format method that normalizes line endings and ensures blank lines around headings without touching fenced code.

```php
class MarkdownFormatter
{
    public static function format(string $content): string
}
```

--------------------------------

### writeIndex output example

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Rules.md

Markdown table generated by writeIndex, listing rule files with matching globs. Includes user and managed rules with non-empty paths, sorted by relative path.

```markdown
# Project Rules Index

Before planning or editing, find the row whose globs match the file's path and read that rule file.

| Applies to | Rule file |
| --- | --- |
| app/Models/**, app/Http/Controllers/** | .ai/rules/controllers.md |
```

--------------------------------

### UpdateCommand class with boost:update signature

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-OtherCommands.md

Defines the boost:update command with options --discover, --no-discover, and --ignore-skills. The --discover option is the default behavior and prompts for newly available guidelines and skills.

```php
#[AsCommand('boost:update', 'Update the Laravel Boost guidelines & skills to the latest guidance')]
class UpdateCommand extends Command
{
    use ReportsSkillParseFailures;

    /** @var string */
    protected $signature = 'boost:update
        {--discover : Discover and prompt for newly available guidelines and skills (default)}
        {--no-discover : Skip discovering and prompting for newly available guidelines and skills}
        {--ignore-skills : Skip updating the skills directory}';
}
```

--------------------------------

### Sail::isActive()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Determines if Sail is active in the current environment. Returns a boolean indicating whether Sail is active.

```APIDOC
## Sail::isActive()

### Description
Determines if Sail is active in the current environment. Returns a boolean indicating whether Sail is active.

### Method
Instance method

### Signature
`isActive(): bool`

### Returns
- **bool** - `false` inside devcontainers (`REMOTE_CONTAINERS === 'true'`); otherwise `true` if `get_current_user() === 'sail'` or `getenv('LARAVEL_SAIL') === '1'`.

### Example
```php
$sail = app(\Laravel\Boost\Install\Sail::class);
$active = $sail->isActive();
```
```

--------------------------------

### RulesIndexCommand class with AsCommand attribute

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-OtherCommands.md

Defines the `boost:index-rules` command using the `AsCommand` attribute and a signature. Regenerates the project rules index from rule files in `.ai/rules`.

```php
#[AsCommand('boost:index-rules', 'Regenerate the project rules index from the rule files in .ai/rules')]
class RulesIndexCommand extends Command
{
    /** @var string */
    protected $signature = 'boost:index-rules';
}
```

--------------------------------

### Sail::nodePackageManagerCommand(string $manager)

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Builds a Sail node package manager command string using the configured binary path and the given manager. Returns the command as a string.

```APIDOC
## Sail::nodePackageManagerCommand(string $manager)

### Description
Builds a Sail node package manager command string using the configured binary path and the given manager. Returns the command as a string.

### Method
Static method

### Signature
`nodePackageManagerCommand(string $manager): string`

### Parameters
- **$manager** (string) - Required - The package manager name (e.g., npm, yarn).

### Returns
- **string** - The command string `{binaryPath()} {manager}`

### Example
```php
$command = Sail::nodePackageManagerCommand('npm');
```
```

--------------------------------

### McpWriter::write

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-McpWriter.md

Installs Boost MCP configuration and optionally Nightwatch MCP configuration into the agent's configuration file. Returns a success code or throws a RuntimeException on failure.

```APIDOC
## `McpWriter::write(?Sail $sail = null, ?Nightwatch $nightwatch = null): int`

### Description
Installs Boost MCP configuration and optionally Nightwatch MCP configuration into the agent's configuration file. Returns a success code or throws a RuntimeException on failure.

### Method
`write`

### Parameters
- `$sail` (?Sail) - Optional - Sail instance for building the Boost MCP command.
- `$nightwatch` (?Nightwatch) - Optional - Nightwatch instance for installing the Nightwatch MCP server.

### Return Value
- `int` - Returns `self::SUCCESS` (0) on success.

### Throws
- `RuntimeException` - If installation fails, with messages like "Failed to install Boost MCP: could not write configuration" or "Failed to install Nightwatch MCP: could not write configuration".

### Usage Example
```php
use Laravel\Boost\Install\McpWriter;
use Laravel\Boost\Install\Agents\ClaudeCode;

$writer = new McpWriter(app(\Laravel\Boost\Install\Agents\ClaudeCode::class));

try {
    $writer->write();              // stdio server into .mcp.json
    $writer->write($sail, $nightwatch); // via Sail, plus Nightwatch HTTP server
} catch (RuntimeException $e) {
    report($e);
}
```
```

--------------------------------

### GetAbsoluteUrl

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Mcp-Tools.md

Get the absolute URL for a given relative path or named route. If no arguments are provided, you will get the absolute URL for `/`.

```APIDOC
## GetAbsoluteUrl

### Description
Get the absolute URL for a given relative path or named route. If no arguments are provided, you will get the absolute URL for `/`.

### Parameters
#### Optional Parameters
- **path** (string) - Optional - Relative URL, e.g. `/dashboard`
- **route** (string) - Optional - Named route, e.g. `home`

### Behavior
- If `path` is provided, returns `url($path)`.
- Else if `route` is provided, returns `route($routeName)`.
- Else returns `url('/')`.

### Response
Returns `Response::text`.
```

--------------------------------

### handle(): int method

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-AddSkillCommand.md

Main entry point for the AddSkill command. Renders header, initializes repository, discovers available skills, and handles the action. Returns self::FAILURE on initialization or discovery failure.

```php
public function handle(): int
{
    $this->displayHeader();

    if (! $this->initializeRepository()) {
        return self::FAILURE;
    }

    if (! $this->discoverAvailableSkills()) {
        return self::FAILURE;
    }

    return $this->handleAction();
}
```

--------------------------------

### boot() method

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Mcp-Server.md

Populates tools, resources, and prompts via discovery methods and overrides the 'tools/call' method to use CallToolWithExecutor.

```php
protected function boot(): void
{
    $this->tools = $this->discoverTools();
    $this->resources = $this->discoverResources();
    $this->prompts = $this->discoverPrompts();

    // Override the tools/call method to use our ToolExecutor
    $this->methods['tools/call'] = CallToolWithExecutor::class;
}
```

--------------------------------

### buildGuidelineConfig(): GuidelineConfig method

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-InstallCommand.md

Builds a GuidelineConfig object with enforcement, API, AI guidelines, Sail, cloud, skills, and MCP settings based on selected features and configuration.

```php
$guidelineConfig = new GuidelineConfig;
$guidelineConfig->enforceTests = $this->enforceTests;
$guidelineConfig->hasAnApi = false;
$guidelineConfig->aiGuidelines = $this->selectedThirdPartyPackages->values()->toArray();
$guidelineConfig->usesSail = $this->shouldUseSail();
$guidelineConfig->usesCloud = $this->selectedBoostFeatures->contains('cloud');
$guidelineConfig->hasSkills = $this->selectedBoostFeatures->contains('skills');
$guidelineConfig->hasMcp = $this->selectedBoostFeatures->contains('mcp') || ($this->isExplicitFlagMode() && $this->config->getMcp());
```

--------------------------------

### boot(Router $router): void method

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/BoostServiceProvider.md

Boots the service provider: registers the local MCP server, publishing, commands, and optionally the browser logs watcher gated by config('boost.browser_logs_watcher', true).

```php
public function boot(Router $router): void
{
    if (! $this->shouldRun()) {
        return;
    }

    Mcp::local('laravel-boost', Boost::class);

    $this->registerPublishing();
    $this->registerCommands();

    if (config('boost.browser_logs_watcher', true)) {
        $this->registerRoutes();
        $this->registerBrowserLogger();
        $this->callAfterResolving('blade.compiler', $this->registerBladeDirectives(...));
        $this->hookIntoResponses($router);
    }
}
```

--------------------------------

### Nightwatch class with MCP_URL constant

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Defines the Nightwatch class with a constant MCP_URL pointing to the Laravel Nightwatch MCP endpoint. Used in the Install support layer.

```php
class Nightwatch
{
    const MCP_URL = 'https://nightwatch.laravel.com/mcp';
}
```

--------------------------------

### GuidelineAssist::binCommand()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-GuidelineAssist.md

Returns a command to run a binary from vendor/bin, e.g., 'vendor/bin/pint'. Honors configured vendor_bin path and Sail.

```APIDOC
## binCommand(string $command)

### Description
Returns a command to run a binary from vendor/bin, e.g., 'vendor/bin/pint'. Honors configured vendor_bin path and Sail.

### Method
binCommand(string $command)

### Parameters
- **$command** (string) - Required - The binary command to run (e.g., 'pint').

### Return Type
string
```

--------------------------------

### ThirdPartyPackage class with readonly properties

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Defines a ThirdPartyPackage data class with readonly properties for name, hasGuidelines, and hasSkills. Used to represent third-party packages in the Install support layer.

```php
class ThirdPartyPackage
{
    public function __construct(
        public readonly string $name,
        public readonly bool $hasGuidelines,
        public readonly bool $hasSkills,
    ) {}
}
```

--------------------------------

### Using DetectionStrategyFactory to create and detect

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Detection.md

Shows how to instantiate DetectionStrategyFactory via the container, create a strategy from config, and run detection for the current platform.

```php
use Laravel\Boost\Install\Detection\DetectionStrategyFactory;
use Laravel\Boost\Install\Enums\Platform;

$factory = app(DetectionStrategyFactory::class);

// Composite strategy from an agent's config.
$strategy = $factory->makeFromConfig([
    'command' => 'command -v claude',
    'paths' => ['.claude'],
]);

$installed = $strategy->detect(['command' => 'command -v claude', 'paths' => ['.claude']], Platform::current());
```

--------------------------------

### LastError

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Mcp-Tools.md

Get details of the last error/exception created in this application on the backend. Use browser-logs tool for browser errors.

```APIDOC
## LastError

### Description
Get details of the last error/exception created in this application on the backend. Use browser-logs tool for browser errors.

### Behavior
1. If a cached error exists, returns `Response::text("[{timestamp}] {level}: {message}" . (context JSON when non-empty))`.
2. Otherwise, reads the last ERROR entry from the default log file, truncated to 500 characters.

### Error Handling
- **No log file**: Returns `Response::error("Log file not found at {path}")`.
- **No ERROR entry in scanned window**: Returns `Response::error('Unable to find an ERROR entry in the inspected portion of the log file.')`.
```

--------------------------------

### DetectionStrategy::detect()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Detection.md

Detects whether an agent is installed based on the provided configuration and platform.

```APIDOC
## DetectionStrategy::detect()

### Description
Detects whether an agent is installed based on the provided configuration and platform.

### Method
`detect(array $config, Platform $platform)`

### Parameters
- **$config** (array) - Required - Configuration array containing 'command' and 'paths' keys.
- **$platform** (Platform) - Required - The current platform.

### Returns
- **bool** - True if the agent is detected, false otherwise.

### Example
```php
$installed = $strategy->detect(['command' => 'command -v claude', 'paths' => ['.claude']], Platform::current());
```
```

--------------------------------

### installFeature generic per-agent processor

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-InstallCommand.md

Protected method that processes a collection of agents, printing a header and optional before-process output, then running a processor per agent. Per-agent exceptions are caught, printed as ✗, and aggregated; individual failures do not stop remaining agents. When withDelay is true, waits usleep(750000) before processing.

```php
/**
 * @template T
 *
 * @param  Collection<int, T>  $agents
 * @param  callable(T): string  $nameResolver
 * @param  callable(T): mixed  $processor
 * @param  ?callable(): void  $beforeProcess
 */
protected function installFeature(
    Collection $agents,
    string $emptyMessage,
    string $headerMessage,
    callable $nameResolver,
    callable $processor,
    string $featureName,
    ?callable $beforeProcess = null,
    bool $withDelay = false,
): void
```

--------------------------------

### hasFormComponent()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-GuidelineAssist.md

Determines if the Inertia version supports form components. Returns true if the installed version is greater than or equal to 2.1.0.

```APIDOC
## hasFormComponent()

### Description
Determines if the Inertia version supports form components. Returns true if the installed version is greater than or equal to 2.1.0.

### Method
N/A (PHP method)

### Endpoint
N/A

### Parameters
None

### Return Value
- **bool** - True if the installed version is >= 2.1.0, false otherwise.

### Example
```php
$assist->inertia()->hasFormComponent()
```
```

--------------------------------

### SupportsMcp interface

Source: https://github.com/laravel/boost/blob/main/_autodocs/types.md

Contract for agents that support MCP installation. Implemented by all 14 bundled agents and consumed by McpWriter.

```php
interface SupportsMcp
{
    public function useAbsolutePathForMcp(): bool;
    public function getPhpPath(bool $forceAbsolutePath = false): string;
    public function getArtisanPath(bool $forceAbsolutePath = false): string;
    public function installMcp(string $key, string $command, array $args = [], array $env = []): bool;
    public function installHttpMcp(string $key, string $url): bool;
}
```

--------------------------------

### Write MCP config through contract methods

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Agents.md

Calls installMcp with the agent's PHP path and Artisan command to set up the Laravel Boost MCP server, and installHttpMcp for an HTTP-based MCP endpoint.

```php
$ok = $agent->installMcp(
    key: 'laravel-boost',
    command: $agent->getPhpPath(),
    args: [$agent->getArtisanPath(), 'boost:mcp'],
);

$okHttp = $agent->installHttpMcp('nightwatch', 'https://nightwatch.laravel.com/mcp');
```

--------------------------------

### hasFormComponentResets()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-GuidelineAssist.md

Determines if the Inertia version supports form component resets. Returns true if the installed version is greater than or equal to 2.1.2.

```APIDOC
## hasFormComponentResets()

### Description
Determines if the Inertia version supports form component resets. Returns true if the installed version is greater than or equal to 2.1.2.

### Method
N/A (PHP method)

### Endpoint
N/A

### Parameters
None

### Return Value
- **bool** - True if the installed version is >= 2.1.2, false otherwise.

### Example
```php
$assist->inertia()->hasFormComponentResets()
```
```

--------------------------------

### ClaudeCode Agent Instantiation and Probing

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Agents.md

Shows how to instantiate the ClaudeCode agent and call its inspection methods to retrieve agent metadata and detect project compatibility.

```APIDOC
## ClaudeCode Agent

### Description
Instantiate the ClaudeCode agent and probe its properties and project detection capabilities.

### Constructor
`new ClaudeCode(DetectionStrategyFactory $factory)`

### Methods
- **name()** - Returns the agent's internal name (e.g., 'claude_code').
- **displayName()** - Returns the human-readable display name (e.g., 'Claude Code').
- **getPhpPath()** - Returns the PHP executable path (default 'php' or configured path).
- **getArtisanPath(bool $absolute = true)** - Returns the path to the artisan file (default base_path('artisan')).
- **detectInProject(string $path)** - Returns a boolean indicating whether the given project path is a Claude Code project.

### Example
```php
use Laravel\Boost\Install\Agents\ClaudeCode;
use Laravel\Boost\Install\Detection\DetectionStrategyFactory;

$agent = new ClaudeCode(app(DetectionStrategyFactory::class));

$agent->name();                            // 'claude_code'
$agent->displayName();                     // 'Claude Code'
$agent->getPhpPath();                      // 'php' or configured path
$agent->getArtisanPath(true);             // base_path('artisan')
$agent->detectInProject(base_path());      // bool — is this a Claude Code project?
```
```

--------------------------------

### composer.json conflict constraint for dual support

Source: https://github.com/laravel/boost/blob/main/UPGRADE.md

Add this conflict to your package's composer.json to prevent installation with Boost versions below 2.5.0, ensuring compatibility when supporting both old and new APIs.

```json
"conflict": {
    "laravel/boost": "<2.5.0"
}
```

--------------------------------

### BoostServiceProvider register() method

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/BoostServiceProvider.md

Merges the package config from config/boost.php under the 'boost' key and binds container singletons. Early returns if shouldRun() is false, skipping the BoostManager, ProjectManager, GuidelineConfig, RuleRepository, and GuidelineAssist bindings. GuidelineConfig defaults usesSail from (new Config)->getSail(), and RuleRepository is constructed with base_path('.ai/rules').

```php
public function register(): void
{
    $this->mergeConfigFrom(
        __DIR__.'/../config/boost.php',
        'boost'
    );

    $this->app->singleton(RenderFailures::class, fn (): RenderFailures => new RenderFailures);
    $this->app->singleton(SkillParseFailures::class, fn (): SkillParseFailures => new SkillParseFailures);

    if (! $this->shouldRun()) {
        return;
    }

    $this->app->singleton(BoostManager::class, fn (): BoostManager => new BoostManager);

    $this->app->singleton(ProjectManager::class, fn (): ProjectManager => new ProjectManager);

    $this->app->singleton(GuidelineConfig::class, function (): GuidelineConfig {
        $config = new GuidelineConfig;
        $config->usesSail = (new Config)->getSail();

        return $config;
    });

    $this->app->singleton(RuleRepository::class, fn (): RuleRepository => new RuleRepository(base_path('.ai/rules')));

    $this->app->singleton(GuidelineAssist::class, fn ($app): GuidelineAssist => new GuidelineAssist(
        $app->make(ProjectManager::class),
        $app->make(GuidelineConfig::class)
    ));
}
```

--------------------------------

### handle method signature

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-OtherCommands.md

Signature of the handle method that processes the update command. It returns an integer status code.

```php
public function handle(Config $config, ProjectManager $project): int
```

--------------------------------

### MCP client requests for prompts and resources

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Mcp-ResourcesAndPrompts.md

Shows how an MCP client addresses prompts by name and resources by URI. Use these JSON-RPC requests to invoke the 'upgrade-livewire-v4' prompt and read the 'file://instructions/application-info.md' resource.

```json
prompts/get  { "name": "upgrade-livewire-v4" }
resources/read { "uri": "file://instructions/application-info.md" }
```

--------------------------------

### Programmatic call to boost:add-skill

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Console-AddSkillCommand.md

Invokes the command programmatically using the Artisan facade with the repo argument and --all flag.

```php
use Illuminate\Support\Facades\Artisan;

Artisan::call('boost:add-skill', ['repo' => 'owner/repo', '--all' => true]);
```

--------------------------------

### Basic Usage of Boost Facade

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Boost.md

Lists all registered agents alphabetically by key.

```php
use Laravel\Boost\Boost;

// List all registered agents (alphabetical by key).
foreach (Boost::getAgents() as $key => $agentClass) {
    echo "{$key}: {$agentClass}".PHP_EOL;
}
```

--------------------------------

### Sail::isRunningInDevcontainer()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Support.md

Checks if the current environment is a devcontainer. Returns a boolean indicating whether running in a devcontainer.

```APIDOC
## Sail::isRunningInDevcontainer()

### Description
Checks if the current environment is a devcontainer. Returns a boolean indicating whether running in a devcontainer.

### Method
Instance method

### Signature
`isRunningInDevcontainer(): bool`

### Returns
- **bool** - `true` if `getenv('REMOTE_CONTAINERS') === 'true'`; otherwise `false`.

### Example
```php
$sail = app(\Laravel\Boost\Install\Sail::class);
$inDevcontainer = $sail->isRunningInDevcontainer();
```
```

--------------------------------

### pagesDirectory()

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-GuidelineAssist.md

Returns the path to the pages directory. Returns 'resources/js/pages' if that directory exists, otherwise 'resources/js/Pages'.

```APIDOC
## pagesDirectory()

### Description
Returns the path to the pages directory. Returns 'resources/js/pages' if that directory exists, otherwise 'resources/js/Pages'.

### Method
N/A (PHP method)

### Endpoint
N/A

### Parameters
None

### Return Value
- **string** - The path to the pages directory.

### Example
```php
$assist->inertia()->pagesDirectory()
```
```

--------------------------------

### GuidelineAssist class constructor and properties

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-GuidelineAssist.md

Defines the GuidelineAssist class with a constructor that accepts a ProjectManager, GuidelineConfig, and optional Collection of skills. The constructor initializes the skills collection to an empty collection if null and discovers enum paths.

```php
class GuidelineAssist
{
    /** @var array<string, string> */
    protected array $enumPaths = [];

    public function __construct(public ProjectManager $project, public GuidelineConfig $config, public ?Collection $skills = null)
    {
        $this->skills ??= collect();
        $this->enumPaths = $this->discover();
    }
}
```

--------------------------------

### discoverPrompts() method

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Mcp-Server.md

Returns a filtered list of prompt classes using filterPrimitives with the 'prompts' type.

```php
return $this->filterPrimitives([
    LaravelCodeSimplifier::class,
    UpgradeAiSdkV1::class,
    UpgradeInertiaV3::class,
    UpgradeLaravelV13::class,
    UpgradeLivewireV4::class,
], 'prompts');
```

--------------------------------

### UpgradeLivewireV4 shouldRegister method

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Mcp-ResourcesAndPrompts.md

Returns true if the project uses Livewire, enabling the upgrade prompt.

```php
return $project->php()->uses(PackageRegistry::LIVEWIRE);
```

--------------------------------

### GuidelineConfig DTO class definition

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-GuidelineAssist.md

Plain public-property DTO with no constructor, used to carry user installation selections into template rendering. All properties default to false except aiGuidelines, which is declared without a default.

```php
class GuidelineConfig
{
    public bool $enforceTests = false;

    public bool $laravelStyle = false;

    public bool $usesSail = false;

    public bool $usesCloud = false;

    public bool $caresAboutLocalization = false;

    public bool $hasAnApi = false;

    public bool $hasSkills = false;

    public bool $hasMcp = false;

    /**
     * @var array<int, string>
     */
    public array $aiGuidelines;
}
```

--------------------------------

### McpInstallationStrategy enum

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Install-Detection.md

String-backed enum for MCP installation strategies. Consumed by Agent::installMcp(): SHELL runs a shell template, FILE writes via FileWriter/TomlFileWriter, NONE returns false.

```php
enum McpInstallationStrategy: string
{
    case SHELL = 'shell';
    case FILE = 'file';
    case NONE = 'none';
}
```

--------------------------------

### buildCommand method

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Mcp-Server.md

Builds the artisan subprocess command array. Uses the configured PHP binary or PHP_BINARY, normalizes it, and appends the artisan script, the boost:execute-tool command, the tool class, and base64-encoded JSON arguments.

```php
$phpBinary = config('boost.executable_paths.php') ?: PHP_BINARY;
$normalized = CommandNormalizer::normalize($phpBinary);

return [
    $normalized['command'],
    ...$normalized['args'],
    base_path('artisan'),
    'boost:execute-tool',
    $toolClass,
    base64_encode(json_encode($arguments)),
];
```

--------------------------------

### discoverResources() method

Source: https://github.com/laravel/boost/blob/main/_autodocs/api-reference/Mcp-Server.md

Returns a filtered list of resource classes using filterPrimitives with the 'resources' type.

```php
return $this->filterPrimitives([
    Resources\ApplicationInfo::class,
], 'resources');
```
Tokens:
Raw