Skip to content

Art & docs #17

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

Merged
merged 15 commits into from
Aug 12, 2025
Merged
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
76 changes: 57 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="center"><img src="/art/logo.svg" alt="Logo Laravel Boost"></p>
<p align="center"><img src="/art/boost.svg" alt="Logo Laravel Boost"></p>

<p align="center">
<a href="https://github.com/laravel/boost/actions"><img src="https://github.com/laravel/boost/workflows/tests/badge.svg" alt="Build Status"></a>
Expand All @@ -7,23 +7,19 @@
<a href="https://packagist.org/packages/laravel/boost"><img src="https://img.shields.io/packagist/l/boost" alt="License"></a>
</p>

> 1. Replace the `art/logo.svg` with the new package logo
> 2. Replace the `public/favicon.ico` with the new package favicon (optional)
> 3. Write a great README

## Introduction
Laravel Boost gives you a jump-start with AI assisted coding by making it simple to add everything you need to help AI make good choices.

Core features:
- MCP server with 15+ tools
- Composable AI guidelines for ecosystem packages
- Documentation API with built-in MCP tool
- Documentation API with built-in MCP tool, over 15, 000 pieces of knowledge, and semantic search with embeddings

Other features:
- Browser logs streamed to `log/storage/browser.log`

> [!IMPORTANT]
> Boost is in Beta and will be updated frequently.
> Boost is in _Beta_ and will be updated frequently.

## Installation

Expand All @@ -39,12 +35,7 @@ php artisan boost:install

You're ready to go!

You can optionally publish the Boost config:
```bash
TODO: the command that allows that
```

## Current MCP Tools
## Available MCP Tools

| Name | Notes |
| -------------------------- |----------------------------------------------------------------------------------------------------------------|
Expand All @@ -65,14 +56,61 @@ TODO: the command that allows that
| Search Docs | Use hosted API service to retrieve docs based on installed packages |
| Tinker | Run arbitrary code within the context of the project |

## Available AI Guidelines

| Package | Versions Supported |
|---------|-------------------|
| Core & Boost | core |
| Laravel Framework | core, v10, v11, v12 |
| Livewire | core, v2, v3 |
| Flux UI | core, free, pro |
| Herd | core |
| Inertia Laravel | core, v1, v2 |
| Inertia React | core, v1, v2 |
| Inertia Vue | core, v1, v2 |
| Pest | core, v4 |
| PHPUnit | core |
| Pint | core |
| TailwindCSS | core, v3, v4 |
| Livewire Volt | core |
| Laravel Folio | core |
| Enforce tests | conditional |


## Available documentation

| Package | Versions Supported |
|---------|-------------------|
| Laravel Framework | v10, v11, v12 |
| Flux UI | v2 Free, v2 Pro |
| Inertia | v1, v2 |
| Livewire | v1, v2, v3 |
| Pest | v3, v4 |

## Adding your own AI guidelines

Add `.blade.php` files to `.ai/guidelines/*` in your project, and they'll be included as part of `boost:install`.

## Official Documentation
## Adding your own AI guidelines

Documentation for Boost can be found on the [Laravel website](https://laravel.com/docs).
Add `.blade.php` files to `.ai/guidelines/*` in your project, and they'll be included with Boost guidelines when you run `boost:install`.

## Adding Boost MCP manually
Create the necessary config for your code editor using these details.

<table>
<tr><td><strong>Command</strong></td><td><code>php</code></td></tr>
<tr><td><strong>Args</strong></td><td><code>./artisan boost:mcp</code></td></tr>
</table>

JSON Example
```json
{
"mcpServers": {
"laravel-boost": {
"command": "php",
"args": ["./artisan", "boost:mcp"]
}
}
}
```

## Contributing

Expand All @@ -88,4 +126,4 @@ Please review [our security policy](https://github.com/laravel/boost/security/po

## License

Laravel AI Assistant is open-sourced software licensed under the [MIT license](LICENSE.md).
Laravel Boost is open-sourced software licensed under the [MIT license](LICENSE.md).
58 changes: 58 additions & 0 deletions art/boost.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading