Skip to content

Conversation

@jordanpartridge
Copy link
Contributor

@jordanpartridge jordanpartridge commented Dec 17, 2025

Problem

When using Boost in monorepos or projects with specific documentation structures, the default guideline file locations (e.g., CLAUDE.md in project root) may not fit the project's organization. Teams may want to consolidate AI guidelines in a dedicated directory or point agents to a shared documentation location.

Solution

This PR adds the ability to customize where Boost writes guideline files for each code environment via Laravel's configuration system. Each agent can have its path configured independently through the boost.code_environments.* config namespace.

Usage

Users can configure custom guideline paths by publishing the Boost config file and adding a code_environments section:

// config/boost.php
return [
    // ... existing config

    'code_environments' => [
        'claude_code' => [
            'guidelines_path' => 'docs/ai/CLAUDE.md',
        ],
        'cursor' => [
            'guidelines_path' => 'docs/ai/cursor-rules.mdc',
        ],
        // ... configure other environments as needed
    ],
];

Or set it programmatically in a service provider:

config(['boost.code_environments.claude_code.guidelines_path' => 'docs/ai/CLAUDE.md']);

Then run php artisan boost:update to regenerate guidelines at the new paths.

Default Paths

If not configured, each environment uses its standard default:

Environment Default Path
Claude Code CLAUDE.md
Codex AGENTS.md
Copilot .github/copilot-instructions.md
Cursor .cursor/rules/laravel-boost.mdc
Gemini GEMINI.md
OpenCode AGENTS.md
PhpStorm .junie/guidelines.md

jordanpartridge and others added 3 commits December 17, 2025 16:41
This adds the ability to customize where Boost writes AI guideline files
(CLAUDE.md, AGENTS.md, etc.) via config and environment variables.
Signed-off-by: Pushpak Chhajed <pushpak1300@gmail.com>
Signed-off-by: Pushpak Chhajed <pushpak1300@gmail.com>
@pushpak1300
Copy link
Member

pushpak1300 commented Dec 18, 2025

I don’t think this change will be used by many people, so I think it should not be added as a default configuration in config boost.php. For now, it can be modified manually if needed. I also don’t want to document this feature at this stage. I’ve updated the MR description accordingly.

@jordanpartridge
Copy link
Contributor Author

I don’t think this change will be used by many people, so I think it should be added as a default configuration in config boost.php. For now, it can be modified manually if needed. I also don’t want to document this feature at this stage. I’ve updated the MR description accordingly.

That makes sense I want quite sure about the change but I figured it would be very useful to a few people.

@pushpak1300 pushpak1300 merged commit 8696dcf into laravel:main Dec 18, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants