Allow configurable guideline paths for AI agents (#392)

* Allow configurable guideline paths for AI agents

This adds the ability to customize where Boost writes AI guideline files
(CLAUDE.md, AGENTS.md, etc.) via config and environment variables.

* Refactor guideline paths configuration

Signed-off-by: Pushpak Chhajed <[email protected]>

* Formatting

Signed-off-by: Pushpak Chhajed <[email protected]>

---------

Signed-off-by: Pushpak Chhajed <[email protected]>
Co-authored-by: Pushpak Chhajed <[email protected]>

Author: jordanpartridge

src/Install/CodeEnvironment/ClaudeCode.php

@@ -53,6 +53,6 @@ public function mcpConfigPath(): string
 
     public function guidelinesPath(): string
     {
-        return 'CLAUDE.md';
+        return config('boost.code_environments.claude_code.guidelines_path', 'CLAUDE.md');
     }
 }

src/Install/CodeEnvironment/Codex.php

@@ -43,7 +43,7 @@ public function projectDetectionConfig(): array
 
     public function guidelinesPath(): string
     {
-        return 'AGENTS.md';
+        return config('boost.code_environments.codex.guidelines_path', 'AGENTS.md');
     }
 
     public function mcpInstallationStrategy(): McpInstallationStrategy

src/Install/CodeEnvironment/Copilot.php

@@ -46,6 +46,6 @@ public function mcpClientName(): ?string
 
     public function guidelinesPath(): string
     {
-        return '.github/copilot-instructions.md';
+        return config('boost.code_environments.copilot.guidelines_path', '.github/copilot-instructions.md');
     }
 }

src/Install/CodeEnvironment/Cursor.php

@@ -56,7 +56,7 @@ public function mcpConfigPath(): string
 
     public function guidelinesPath(): string
     {
-        return '.cursor/rules/laravel-boost.mdc';
+        return config('boost.code_environments.cursor.guidelines_path', '.cursor/rules/laravel-boost.mdc');
     }
 
     public function frontmatter(): bool

src/Install/CodeEnvironment/Gemini.php

@@ -47,6 +47,6 @@ public function mcpConfigPath(): string
 
     public function guidelinesPath(): string
     {
-        return 'GEMINI.md';
+        return config('boost.code_environments.gemini.guidelines_path', 'GEMINI.md');
     }
 }

src/Install/CodeEnvironment/OpenCode.php

@@ -52,7 +52,7 @@ public function mcpConfigPath(): string
 
     public function guidelinesPath(): string
     {
-        return 'AGENTS.md';
+        return config('boost.code_environments.opencode.guidelines_path', 'AGENTS.md');
     }
 
     public function mcpConfigKey(): string

src/Install/CodeEnvironment/PhpStorm.php

@@ -65,6 +65,6 @@ public function mcpConfigPath(): string
 
     public function guidelinesPath(): string
     {
-        return '.junie/guidelines.md';
+        return config('boost.code_environments.phpstorm.guidelines_path', '.junie/guidelines.md');
     }
 }

tests/Unit/Install/CodeEnvironment/ClaudeCodeTest.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit\Install\CodeEnvironment;
+
+use Laravel\Boost\Install\CodeEnvironment\ClaudeCode;
+use Laravel\Boost\Install\Detection\DetectionStrategyFactory;
+use Laravel\Boost\Install\Enums\Platform;
+use Mockery;
+
+beforeEach(function (): void {
+    $this->strategyFactory = Mockery::mock(DetectionStrategyFactory::class);
+});
+
+test('systemDetectionConfig returns command-based detection for all platforms', function (): void {
+    $claude = new ClaudeCode($this->strategyFactory);
+
+    expect($claude->systemDetectionConfig(Platform::Darwin))
+        ->toHaveKey('command')
+        ->and($claude->systemDetectionConfig(Platform::Linux))
+        ->toHaveKey('command')
+        ->and($claude->systemDetectionConfig(Platform::Windows))
+        ->toHaveKey('command');
+});
+
+test('guidelinesPath returns default CLAUDE.md when no config set', function (): void {
+    $claude = new ClaudeCode($this->strategyFactory);
+
+    expect($claude->guidelinesPath())->toBe('CLAUDE.md');
+});
+
+test('guidelinesPath returns a custom path from config', function (): void {
+    config(['boost.code_environments.claude_code.guidelines_path' => '.claude/CLAUDE.md']);
+
+    $claude = new ClaudeCode($this->strategyFactory);
+
+    expect($claude->guidelinesPath())->toBe('.claude/CLAUDE.md');
+});
+
+test('guidelinesPath returns a nested custom path from config', function (): void {
+    config(['boost.code_environments.claude_code.guidelines_path' => 'docs/ai/CLAUDE.md']);
+
+    $claude = new ClaudeCode($this->strategyFactory);
+
+    expect($claude->guidelinesPath())->toBe('docs/ai/CLAUDE.md');
+});

tests/Unit/Install/CodeEnvironment/CodexTest.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit\Install\CodeEnvironment;
+
+use Laravel\Boost\Install\CodeEnvironment\Codex;
+use Laravel\Boost\Install\Detection\DetectionStrategyFactory;
+use Laravel\Boost\Install\Enums\Platform;
+use Mockery;
+
+beforeEach(function (): void {
+    $this->strategyFactory = Mockery::mock(DetectionStrategyFactory::class);
+});
+
+test('systemDetectionConfig returns command-based detection for all platforms', function (): void {
+    $codex = new Codex($this->strategyFactory);
+
+    expect($codex->systemDetectionConfig(Platform::Darwin))
+        ->toHaveKey('command')
+        ->and($codex->systemDetectionConfig(Platform::Linux))
+        ->toHaveKey('command')
+        ->and($codex->systemDetectionConfig(Platform::Windows))
+        ->toHaveKey('command');
+});
+
+test('guidelinesPath returns default AGENTS.md when no config set', function (): void {
+    $codex = new Codex($this->strategyFactory);
+
+    expect($codex->guidelinesPath())->toBe('AGENTS.md');
+});
+
+test('guidelinesPath returns a custom path from config', function (): void {
+    config(['boost.code_environments.codex.guidelines_path' => 'docs/AGENTS.md']);
+
+    $codex = new Codex($this->strategyFactory);
+
+    expect($codex->guidelinesPath())->toBe('docs/AGENTS.md');
+});

tests/Unit/Install/CodeEnvironment/CopilotTest.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit\Install\CodeEnvironment;
+
+use Laravel\Boost\Install\CodeEnvironment\Copilot;
+use Laravel\Boost\Install\Detection\DetectionStrategyFactory;
+use Laravel\Boost\Install\Enums\Platform;
+use Mockery;
+
+beforeEach(function (): void {
+    $this->strategyFactory = Mockery::mock(DetectionStrategyFactory::class);
+});
+
+test('detectOnSystem always returns false', function (): void {
+    $copilot = new Copilot($this->strategyFactory);
+
+    expect($copilot->detectOnSystem(Platform::Darwin))->toBeFalse()
+        ->and($copilot->detectOnSystem(Platform::Linux))->toBeFalse()
+        ->and($copilot->detectOnSystem(Platform::Windows))->toBeFalse();
+});
+
+test('guidelinesPath returns a default path when no config set', function (): void {
+    $copilot = new Copilot($this->strategyFactory);
+
+    expect($copilot->guidelinesPath())->toBe('.github/copilot-instructions.md');
+});
+
+test('guidelinesPath returns a custom path from config', function (): void {
+    config(['boost.code_environments.copilot.guidelines_path' => 'docs/copilot.md']);
+
+    $copilot = new Copilot($this->strategyFactory);
+
+    expect($copilot->guidelinesPath())->toBe('docs/copilot.md');
+});