> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Laravel Boost

> Laravel Boost ist ein Paket, das KI-gestützte Entwicklung beschleunigt. Über einen MCP-Server, KI-Richtlinien und Agent Skills befähigt es KI-Coding-Agenten, Ihre Laravel-Anwendung tiefgehend zu verstehen.

## Einführung

Laravel Boost ist ein Paket, das KI-gestützte Entwicklung beschleunigt, indem es KI-Agenten die nötigen Richtlinien und Agent Skills an die Hand gibt, um hochwertige Laravel-Anwendungen im Einklang mit den Laravel-Best-Practices zu schreiben.

Boost stellt zudem eine leistungsfähige Dokumentations-API für das Laravel-Ökosystem bereit, die eine Wissensbasis mit über 17.000 Laravel-spezifischen Informationen mit semantischer Suche über Embeddings kombiniert. Boost weist KI-Agenten wie Claude Code oder Cursor an, diese API zu nutzen, um sich über aktuelle Laravel-Funktionen und Best Practices zu informieren.

## Installation

Laravel Boost wird über Composer installiert.

```shell theme={null}
composer require laravel/boost --dev
```

Anschließend installieren Sie den MCP-Server und die Coding-Richtlinien.

```shell theme={null}
php artisan boost:install
```

Der Befehl `boost:install` erzeugt die passenden Richtlinien- und Skill-Dateien für den bei der Installation ausgewählten Coding-Agenten.

Nach abgeschlossener Installation können Sie mit Cursor, Claude Code oder einem beliebigen anderen KI-Agenten Ihrer Wahl mit dem Programmieren beginnen.

> [!NOTE]
>
> Die generierte MCP-Konfigurationsdatei (`.mcp.json`), die Richtliniendateien (`CLAUDE.md`, `AGENTS.md`, `junie/` usw.) und die Konfigurationsdatei `boost.json` können Sie problemlos in die `.gitignore` Ihrer Anwendung aufnehmen. Diese Dateien werden bei jedem Aufruf von `boost:install` oder `boost:update` automatisch neu erzeugt.

### Agent konfigurieren

> [tab] Cursor
>
> 1. Öffnen Sie die Befehlspalette (`Cmd+Shift+P` oder `Ctrl+Shift+P`).
> 2. Wählen Sie „/open MCP Settings" und drücken Sie `Enter`.
> 3. Aktivieren Sie den Schalter neben `laravel-boost`.

> [tab] Claude Code
>
> Die Unterstützung für Claude Code wird in der Regel automatisch aktiviert. Falls nicht, öffnen Sie eine Shell im Projektverzeichnis und führen Sie folgenden Befehl aus:
>
> ```shell theme={null}
> claude mcp add -s local -t stdio laravel-boost php artisan boost:mcp
> ```

> [tab] Codex
>
> Die Unterstützung für Codex wird in der Regel automatisch aktiviert. Falls nicht, öffnen Sie eine Shell im Projektverzeichnis und führen Sie folgenden Befehl aus:
>
> ```shell theme={null}
> codex mcp add laravel-boost -- php "artisan" "boost:mcp"
> ```

> [tab] Gemini CLI
>
> Die Unterstützung für Gemini CLI wird in der Regel automatisch aktiviert. Falls nicht, öffnen Sie eine Shell im Projektverzeichnis und führen Sie folgenden Befehl aus:
>
> ```shell theme={null}
> gemini mcp add -s project -t stdio laravel-boost php artisan boost:mcp
> ```

> [tab] GitHub Copilot (VS Code)
>
> 1. Öffnen Sie die Befehlspalette (`Cmd+Shift+P` oder `Ctrl+Shift+P`).
> 2. Wählen Sie „MCP: List Servers" und drücken Sie `Enter`.
> 3. Wählen Sie `laravel-boost` und drücken Sie `Enter`.
> 4. Wählen Sie „Start server".

> [tab] Junie
>
> 1. Drücken Sie zweimal `Shift`, um die Befehlspalette zu öffnen.
> 2. Suchen Sie nach „MCP Settings" und drücken Sie `Enter`.
> 3. Setzen Sie das Häkchen neben `laravel-boost`.
> 4. Klicken Sie unten rechts auf „Apply".

### Boost-Ressourcen aktualisieren

Damit die installierten Laravel-Ökosystem-Pakete stets in der aktuellen Version widergespiegelt werden, empfiehlt es sich, die lokalen Boost-Ressourcen (KI-Richtlinien und Skills) regelmäßig zu aktualisieren. Verwenden Sie hierfür den Artisan-Befehl `boost:update`.

```shell theme={null}
php artisan boost:update
```

Sie können dies automatisieren, indem Sie den Befehl in das Composer-Skript `post-update-cmd` eintragen.

```json theme={null}
{
  "scripts": {
    "post-update-cmd": [
      "@php artisan boost:update --ansi"
    ]
  }
}
```

Standardmäßig aktualisiert `boost:update` nur die Boost-Ressourcen, die bereits in der Anwendung veröffentlicht sind. Wenn Sie neu installierte Pakete erkennen lassen und zur Veröffentlichung deren Richtlinien und Skills auffordern möchten, verwenden Sie die Option `--discover`.

```shell theme={null}
php artisan boost:update --discover
```

## MCP-Server

Laravel Boost bringt einen MCP-Server (Model Context Protocol) mit, der KI-Agenten Tools zur Interaktion mit Ihrer Laravel-Anwendung bereitstellt. Damit können Agenten die Struktur der Anwendung erkunden, die Datenbank abfragen oder Code ausführen.

### Verfügbare MCP-Tools

| Toolname | Beschreibung |
| - | - |
| Application Info | Liest die PHP- und Laravel-Version, die Datenbank-Engine, eine Liste der versionierten Ökosystem-Pakete sowie die Eloquent-Modelle aus |
| Browser Logs | Liest Logs und Fehler aus dem Browser |
| Database Connections | Ermittelt die verfügbaren Datenbankverbindungen, einschließlich der Standardverbindung |
| Database Query | Führt eine Abfrage gegen die Datenbank aus |
| Database Schema | Liest das Datenbankschema |
| Get Absolute URL | Wandelt eine relative Pfad-URI in eine absolute URL um, damit der Agent gültige URLs erzeugen kann |
| Last Error | Liest den letzten Fehler aus der Log-Datei der Anwendung |
| Read Log Entries | Liest die letzten N Log-Einträge |
| Record Rule | Legt persistente [Projektregeln](#projektregeln) in `.ai/rules` ab, die zukünftige Agenten übernehmen |
| Search Docs | Fragt den gehosteten Dokumentations-API-Dienst von Laravel basierend auf den installierten Paketen ab |

### MCP-Server manuell registrieren

Je nach Editor müssen Sie den Laravel-Boost-MCP-Server unter Umständen manuell registrieren. Verwenden Sie dazu die folgenden Angaben:

| Feld | Wert |
| - | - |
| **Command** | `php` |
| **Args** | `artisan boost:mcp` |

Beispiel im JSON-Format:

```json theme={null}
{
    "mcpServers": {
        "laravel-boost": {
            "command": "php",
            "args": ["artisan", "boost:mcp"]
        }
    }
}
```

## KI-Richtlinien

KI-Richtlinien sind Anweisungsdateien, die vorab geladen werden, um KI-Agenten wichtige Kontextinformationen zu den Paketen des Laravel-Ökosystems bereitzustellen. Sie enthalten zentrale Konventionen, Best Practices und Framework-spezifische Muster und helfen dem Agenten, konsistenten, hochwertigen Code zu erzeugen.

### Verfügbare Richtlinien

Laravel Boost enthält KI-Richtlinien für die folgenden Pakete und Frameworks. Die `core`-Richtlinie enthält allgemeine, versionsunabhängige Empfehlungen.

| Paket | Unterstützte Versionen |
| - | - |
| Core & Boost | core |
| Laravel Framework | core, 10.x, 11.x, 12.x |
| Livewire | core, 2.x, 3.x, 4.x |
| Flux UI | core, free, pro |
| Folio | core |
| Herd | core |
| Inertia Laravel | core, 1.x, 2.x, 3.x |
| Inertia React | core, 1.x, 2.x, 3.x |
| Inertia Vue | core, 1.x, 2.x, 3.x |
| Inertia Svelte | core, 1.x, 2.x, 3.x |
| MCP | core |
| Pennant | core |
| Pest | core, 3.x, 4.x |
| PHPUnit | core |
| Pint | core |
| Sail | core |
| Tailwind CSS | core, 3.x, 4.x |
| Livewire Volt | core |
| Wayfinder | core |
| Enforce Tests | conditional |

> [!TIP]
>
> Wie Sie die KI-Richtlinien aktuell halten, erfahren Sie unter [Boost-Ressourcen aktualisieren](#boost-ressourcen-aktualisieren).

### Eigene Richtlinien ergänzen

Um eigene KI-Richtlinien zu Laravel Boost hinzuzufügen, legen Sie `.blade.php`- oder `.md`-Dateien im Verzeichnis `.ai/guidelines/*` Ihrer Anwendung ab. Diese Dateien werden bei `boost:install` automatisch mit den Boost-Richtlinien kombiniert.

### Boost-Richtlinien überschreiben

Sie können in Boost integrierte Richtlinien überschreiben, indem Sie eine eigene Richtlinie mit übereinstimmendem Pfad anlegen. Existiert eine eigene Datei unter dem gleichen Pfad wie eine bestehende Boost-Richtlinie, verwendet Boost Ihre Version anstelle der Standardrichtlinie.

Um zum Beispiel die Boost-Richtlinie „Inertia React v2 Form Guidance" zu überschreiben, legen Sie eine Datei unter `.ai/guidelines/inertia-react/2/forms.blade.php` an. Beim nächsten Aufruf von `boost:install` nutzt Boost dann Ihre eigene Richtlinie anstelle der Standardversion.

### Richtlinien für Fremdpakete

Wenn Sie ein Fremdpaket pflegen und in Boost KI-Richtlinien für Ihr Paket bereitstellen möchten, fügen Sie Ihrem Paket eine Datei `resources/boost/guidelines/core.blade.php` hinzu. Wenn ein Nutzer des Pakets `php artisan boost:install` ausführt, lädt Boost Ihre Richtlinien automatisch mit.

Beschreiben Sie in Ihren KI-Richtlinien eine Übersicht des Pakets, die erforderliche Dateistruktur bzw. Konventionen sowie die Vorgehensweise für zentrale Funktionen (inklusive Befehlen und Codebeispielen). Halten Sie sich kurz und aktionsorientiert und konzentrieren Sie sich auf Best Practices, damit die KI korrekten Code für Ihre Nutzerinnen und Nutzer generieren kann.

```php theme={null}
## Package Name

This package provides [brief description of functionality].

### Features

- Feature 1: [clear & short description].
- Feature 2: [clear & short description]. Example usage:

@verbatim
<code-snippet name="How to use Feature 2" lang="php">
$result = PackageName::featureTwo($param1, $param2);
</code-snippet>
@endverbatim
```

## Agent Skills

[Agent Skills](https://agentskills.io/home) sind schlanke, fokussierte Wissensmodule, die Agenten bei Bedarf aktivieren können, wenn sie in einer bestimmten Domäne arbeiten. Anders als Richtlinien, die stets vorab geladen werden, laden Skills detaillierte Muster und Best Practices nur, wenn sie relevant sind. Dadurch bleiben Kontextfenster schlank, und die Qualität des von der KI erzeugten Codes steigt.

Wenn Sie `boost:install` ausführen und Skills als Feature auswählen, werden Skills basierend auf den in der `composer.json` erkannten Paketen automatisch installiert. Enthält Ihr Projekt zum Beispiel `livewire/livewire`, wird der Skill `livewire-development` automatisch installiert. In Boost enthaltene Skills wie `infer-conventions` werden unabhängig von den vorhandenen Paketen installiert.

### Verfügbare Skills

| Skill | Paket |
| - | - |
| fluxui-development | Flux UI |
| folio-routing | Folio |
| infer-conventions | Boost |
| inertia-react-development | Inertia React |
| inertia-svelte-development | Inertia Svelte |
| inertia-vue-development | Inertia Vue |
| livewire-development | Livewire |
| mcp-development | MCP |
| pennant-development | Pennant |
| pest-testing | Pest |
| tailwindcss-development | Tailwind CSS |
| volt-development | Volt |
| wayfinder-development | Wayfinder |

> [!TIP]
>
> Wie Sie Skills aktuell halten, erfahren Sie unter [Boost-Ressourcen aktualisieren](#boost-ressourcen-aktualisieren).

### Eigene Skills erstellen

Um einen eigenen Skill anzulegen, erstellen Sie eine Datei `SKILL.md` unter `.ai/skills/{skill-name}/` in Ihrer Anwendung. Bei `boost:update` werden Ihre eigenen Skills zusammen mit den in Boost integrierten Skills installiert.

Für einen Skill zu einer anwendungsspezifischen Domänenlogik könnte das etwa so aussehen:

```
.ai/skills/creating-invoices/SKILL.md
```

### Skills überschreiben

Sie können in Boost integrierte Skills überschreiben, indem Sie einen eigenen Skill mit demselben Namen anlegen. Existiert ein eigener Skill mit dem gleichen Namen wie ein bestehender Boost-Skill, verwendet Boost Ihre Version anstelle des Standard-Skills.

Um zum Beispiel den Boost-Skill `livewire-development` zu überschreiben, legen Sie eine Datei unter `.ai/skills/livewire-development/SKILL.md` an. Beim nächsten Aufruf von `boost:update` nutzt Boost dann Ihren eigenen Skill anstelle der Standardversion.

### Skills für Fremdpakete

Wenn Sie ein Fremdpaket pflegen und in Boost Skills für Ihr Paket bereitstellen möchten, fügen Sie eine Datei `resources/boost/skills/{skill-name}/SKILL.md` zu Ihrem Paket hinzu. Führt ein Nutzer `php artisan boost:install` aus, installiert Boost den Skill auf Wunsch automatisch.

Boost-Skills unterstützen das Agent-Skills-Format. Sie sind als Ordner mit einer `SKILL.md`-Datei aufgebaut, die YAML-Frontmatter und Markdown-Anweisungen enthält. Die `SKILL.md`-Datei muss die Pflicht-Frontmatter (`name` und `description`) enthalten und kann optional Skripte, Vorlagen und Referenzmaterial umfassen.

```markdown theme={null}
---
name: package-name-development
description: Build and work with PackageName features, including components and workflows.
---

# Package Name Development

## When to use this skill
Use this skill when working with PackageName features...

## Features

- Feature 1: [clear & short description].
- Feature 2: [clear & short description]. Example usage:

$result = PackageName::featureTwo($param1, $param2);
```

## Vergleich: Richtlinien und Skills

Laravel Boost bietet zwei unterschiedliche Wege, um KI-Agenten Kontext zu Ihrer Anwendung zu geben: **Richtlinien** und **Skills**.

**Richtlinien** werden beim Start des KI-Agenten vorab geladen und liefern wichtigen, breit anwendbaren Kontext zu Laravel-Konventionen und Best Practices, die für die gesamte Codebasis relevant sind.

**Skills** werden bei Bedarf aktiviert, wenn Sie an einer konkreten Aufgabe arbeiten, und enthalten detaillierte Muster für eine bestimmte Domäne (z. B. Livewire-Komponenten oder Pest-Tests). Weil Skills nur bei Bedarf geladen werden, bleibt der Kontext schlank und die Codequalität steigt.

| Aspekt | Richtlinie | Skill |
| - | - | - |
| **Ladezeitpunkt** | Vorab, immer vorhanden | Bei Bedarf, nur wenn relevant |
| **Geltungsbereich** | Breit, grundlegend | Fokussiert, aufgabenspezifisch |
| **Zweck** | Kernkonventionen und Best Practices | Detaillierte Implementierungsmuster |

Richtlinien und Skills vermitteln Wissen über das Laravel-Ökosystem. Um KI-Agenten anwendungsspezifische Konventionen zu vermitteln, nutzen Sie [Projektregeln](#projektregeln).

## Projektregeln

Während Richtlinien und Skills vermitteln, wie man Laravel-Code schreibt, vermitteln Projektregeln, wie man den Code Ihrer Anwendung schreibt. Regeln decken Dinge ab, die Sie sonst in jeder neuen Sitzung erneut erklären müssten, etwa:

* Design-Entscheidungen, die Sie, ein Agent oder Teammitglieder getroffen haben
* Style Guides und Präferenzen, die sich in Agenten nur schwer durchsetzen lassen
* Einschränkungen und Fallstricke, die sich nicht aus dem umliegenden Code ableiten lassen

Legen Sie Regeln als Markdown-Dateien im Verzeichnis `.ai/rules` der Anwendung ab und committen Sie sie in die Versionsverwaltung. Anders als das pro Nutzer und Sitzung bestehende Agent-Gedächtnis werden Regeln im Team geteilt und stehen jedem Agenten zur Verfügung, der an der Anwendung arbeitet.

Die Frontmatter jeder Regel-Datei legt die Datei-Globs fest, für die sie gilt.

```markdown theme={null}
---
paths:
  - app/Http/Controllers/**
---

# Http Controllers

## BaseController für Tenant-Scoping erweitern

Alle Controller erweitern `App\Http\Controllers\BaseController`.
Diese Klasse wendet den Query-Scope des aktuellen Tenants an.
Ein direktes Erweitern des Base-Controllers von Laravel lässt Daten zwischen Tenants durchsickern.
```

Boost pflegt zusätzlich eine Datei `.ai/rules/index.md`, die die Zuordnung von Globs zu Regel-Dateien festhält. Agenten werden angewiesen, diesen Index vor dem Planen oder Bearbeiten von Dateien zu konsultieren, sodass nur relevante Regeln geladen werden.

```markdown theme={null}
# Project Rules Index

Suchen Sie vor dem Planen oder Bearbeiten nach der Glob-Zeile, die zum Dateipfad passt, und lesen Sie die zugehörige Regel-Datei.

| Gilt für | Regel-Datei |
| --- | --- |
| app/Http/Controllers/** | .ai/rules/controllers.md |
| app/Models/** | .ai/rules/models.md |
```

> [!NOTE]
>
> Anders als `.mcp.json` oder generierte Richtlinien-Dateien wird das Verzeichnis `.ai/rules` in die Versionsverwaltung committet, damit das Team die Regeln teilen kann.

### Regeln aufzeichnen

Sie können eine Regel aufzeichnen, indem Sie den Agenten einfach bitten, sich diese zu merken.

```text theme={null}
Store all amounts as integer cents, not floats.
```

Der Agent ruft das Boost-MCP-Tool `record-rule` mit einem `glob`, einem kurzen `title` und einer `note` auf. Boost legt die Regel im passenden Bereich ab und erstellt bei Bedarf eine Regel-Datei und aktualisiert den Index.

Erstellen Sie Regel-Dateien nicht manuell; zeichnen Sie sie immer über das Tool `record-rule` auf. Wird eine Regel aufgezeichnet, regeneriert Boost `.ai/rules/index.md`. Agenten finden anwendbare Regeln über diesen Index, sodass eine manuell hinzugefügte Regel-Datei erst gefunden wird, wenn der Index regeneriert wurde.

### Konventionen der Anwendung ableiten

Bestehende Anwendungen enthalten Konventionen, die sich über Jahre angesammelt haben. Der Skill `infer-conventions` erzeugt Regeln aus dem Code, den Sie bereits geschrieben haben. Bitten Sie den Agenten dazu zunächst:

```text theme={null}
Use the infer-conventions skill
```

Der Skill untersucht Konventionen anhand einer Checkliste, die Validierung, Controller, Autorisierung, Modelle, Architektur, Tests, Frontend, Datenbank und Konsole umfasst, und untersucht anschließend weitere Muster wie Basisklassen, gemeinsame Traits und Modulstruktur frei.

Der Skill zeichnet auf, was der Code tatsächlich tut, nicht was er idealerweise tun sollte. Er zeichnet nur charakteristische Konventionen mit ausreichender Beweislage auf und schließt Framework-Standards oder alles, was Pint und Rector bereits erzwingen, aus. Sind Muster gemischt, meldet er dies, statt eine Regel zu erzwingen. Bevor irgendwelche Regeln geschrieben werden, präsentiert er die gefundenen Konventionen und Beweise zur Genehmigung. Um alle Konventionen ohne Rückfrage aufzuzeichnen, sagen Sie „yolo“.

### Projektregeln deaktivieren

Projektregeln sind standardmäßig aktiviert. Um sie vollständig zu deaktivieren, definieren Sie folgende Umgebungsvariable. Das MCP-Tool `record-rule` wird entfernt und Boost verwaltet das Verzeichnis `.ai/rules` nicht mehr.

```ini theme={null}
BOOST_RULES_ENABLED=false
```

## Dokumentations-API

Laravel Boost enthält eine Dokumentations-API, die KI-Agenten Zugriff auf eine Wissensbasis mit über 17.000 Laravel-spezifischen Informationen ermöglicht. Diese API nutzt semantische Suche über Embeddings, um besonders präzise und kontextbewusste Ergebnisse zu liefern.

Über das MCP-Tool `Search Docs` können Agenten den gehosteten Dokumentations-API-Dienst von Laravel basierend auf den installierten Paketen abfragen. Boosts KI-Richtlinien und Skills weisen Coding-Agenten automatisch an, diese API zu verwenden.

| Paket | Unterstützte Versionen |
| - | - |
| Laravel Framework | 10.x, 11.x, 12.x |
| Filament | 2.x, 3.x, 4.x, 5.x |
| Flux UI | 2.x Free, 2.x Pro |
| Inertia | 1.x, 2.x |
| Livewire | 1.x, 2.x, 3.x, 4.x |
| Nova | 4.x, 5.x |
| Pest | 3.x, 4.x |
| Tailwind CSS | 3.x, 4.x |

## Boost erweitern

Boost funktioniert mit vielen gängigen IDEs und KI-Agenten sofort. Falls Ihr Coding-Tool noch nicht unterstützt wird, können Sie einen eigenen Agenten erstellen und in Boost integrieren.

### Unterstützung für weitere IDEs/KI-Agenten hinzufügen

Um Unterstützung für eine neue IDE oder einen neuen KI-Agenten hinzuzufügen, erstellen Sie eine Klasse, die von `Laravel\Boost\Install\Agents\Agent` erbt, und implementieren Sie je nach Bedarf eines oder mehrere der folgenden Contracts:

* `Laravel\Boost\Contracts\SupportsGuidelines` — fügt Unterstützung für KI-Richtlinien hinzu
* `Laravel\Boost\Contracts\SupportsMcp` — fügt MCP-Unterstützung hinzu
* `Laravel\Boost\Contracts\SupportsSkills` — fügt Unterstützung für Agent Skills hinzu

#### Agenten implementieren

```php theme={null}
<?php

declare(strict_types=1);

namespace App;

use Laravel\Boost\Contracts\SupportsGuidelines;
use Laravel\Boost\Contracts\SupportsMcp;
use Laravel\Boost\Contracts\SupportsSkills;
use Laravel\Boost\Install\Agents\Agent;

class CustomAgent extends Agent implements SupportsGuidelines, SupportsMcp, SupportsSkills
{
    // Your implementation...
}
```

Als Referenz für eine Implementierung dient [ClaudeCode.php](https://github.com/laravel/boost/blob/main/src/Install/Agents/ClaudeCode.php).

#### Agenten registrieren

Registrieren Sie Ihren eigenen Agenten in der `boot`-Methode von `App\Providers\AppServiceProvider`.

```php theme={null}
use Laravel\Boost\Boost;

public function boot(): void
{
    Boost::registerAgent('customagent', CustomAgent::class);
}
```

Nach der Registrierung erscheint Ihr Agent bei jedem Aufruf von `php artisan boost:install` als Auswahloption.


## Related topics

- [Laravel und KI-Entwicklung](https://kawax.biz/de/ai.md)
- [Laravel MCP](https://kawax.biz/de/mcp.md)
- [Laravel Boost Custom Agent for GitHub Copilot CLI](https://kawax.biz/de/packages/laravel-boost-copilot-cli.md)
- [Laravel Boost Custom Agent for PhpStorm with GitHub Copilot](https://kawax.biz/de/packages/laravel-boost-phpstorm-copilot.md)
- [KI-Agenten: Von „korrektem“ Code zu „idiomatischem Laravel“ – Der nächste Schritt der Boost Benchmarks](https://kawax.biz/de/blog/boost-benchmarks-idiomatic-laravel.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.