Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

feat: add environment variable configuration for non-interactive installs #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mischasigtermans wants to merge 3 commits into laravel:main
base: main
Choose a base branch
Loading
from mischasigtermans:main
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions README.md
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,67 @@ php artisan boost:install

Once Laravel Boost has been installed, you're ready to start coding with Cursor, Claude Code, or your AI agent of choice.

## Configuration

### Non-Interactive Installation

For a faster installation workflow when you already know your preferences, you can skip the interactive prompts using the `--no-interaction` or `-n` flag:

```bash
php artisan boost:install -n
```

### Environment Variables

You can configure the installation behavior using environment variables in your `.env` file:

```bash
# Control what gets installed
BOOST_MCP_SERVER=true # Install MCP server (default: true)
BOOST_AI_GUIDELINES=true # Install AI guidelines (default: true)
BOOST_HERD=false # Install Herd MCP server (default: false)

# Pre-select agents and editors (comma-separated)
BOOST_AGENTS=claudecode # Agents for AI guidelines
BOOST_EDITORS=claudecode # Editors for MCP installation

# Test enforcement in AI guidelines
BOOST_ENFORCE_TESTS=true # Always create tests (default: auto-detect)
```

**Available Agents:**
- `claudecode` - Claude Code
- `cursor` - Cursor
- `copilot` - GitHub Copilot (no MCP support)
- `phpstorm` - PhpStorm/Junie

**Available Editors:**
- `claudecode` - Claude Code
- `cursor` - Cursor
- `phpstorm` - PhpStorm
- `vscode` - VS Code (MCP only)

**Special Values:**
- Set `BOOST_AI_GUIDELINES=false` to skip AI guidelines installation entirely
- Environment variables work as **defaults** in interactive mode, or **enforced values** with `--no-interaction`

### Configuration File

You can also set defaults in your `config/boost.php` file:

```php
return [
'install' => [
'mcp_server' => true,
'ai_guidelines' => true,
'herd' => false,
'enforce_tests' => true,
'agents' => 'claudecode',
'editors' => 'claudecode',
],
];
```

## Available MCP Tools

| Name | Notes |
Expand Down
19 changes: 19 additions & 0 deletions config/boost.php
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,23 @@

'browser_logs_watcher' => env('BOOST_BROWSER_LOGS_WATCHER', true),

/*
|--------------------------------------------------------------------------
| Installation Defaults
|--------------------------------------------------------------------------
|
| These options control the default behavior during boost:install command.
| You can override these via environment variables or use them as defaults
| for non-interactive installations.
*/

'install' => [
'mcp_server' => env('BOOST_MCP_SERVER', true),
'ai_guidelines' => env('BOOST_AI_GUIDELINES', true),
'herd' => env('BOOST_HERD', false),
'enforce_tests' => env('BOOST_ENFORCE_TESTS'),
'agents' => env('BOOST_AGENTS'),
'editors' => env('BOOST_EDITORS'),
],

];
Loading

AltStyle によって変換されたページ (->オリジナル) /