leek/laravel-docs-index

Download package docs locally and inject a compressed index into agent guidelines files

dev-main 2026-02-07 16:38 UTC

Requires

• php: ^8.2
• illuminate/console: ^11.0|^12.0
• illuminate/support: ^11.0|^12.0
• symfony/finder: ^7.0
• symfony/process: ^7.0

Requires (Dev)

• orchestra/testbench: ^9.0|^10.0
• pestphp/pest: ^3.0

MIT

• Chris Lee

• docs
• laravel
• cursor
• agents
• ai
• claude
• windsurf

README

A Laravel package that downloads package documentation locally and injects a compressed index into your AI agent guidelines files (CLAUDE.md, .cursorrules, .windsurfrules, etc.).

This helps AI coding assistants access up-to-date documentation for your installed Laravel ecosystem packages.

Installation

composer require leek/laravel-docs-index --dev

The package will auto-register with Laravel.

Usage

Run the command to download docs and inject the index:

php artisan docs:index

On first run, the command will:

1. Detect existing agent guidelines files (CLAUDE.md, .cursorrules, etc.)
2. Ask which files should receive the docs index
3. Save your preferences to docs-index.json
4. Download documentation for installed packages
5. Inject a compressed index into your selected files

Options

# Force re-download (delete and re-clone)
php artisan docs:index --force

# Only process specific packages
php artisan docs:index --package=laravel/docs
php artisan docs:index --package=filamentphp/filament

Supported Packages

The following packages are automatically detected and their documentation downloaded:

Package	Documentation Source
laravel/framework	laravel/docs
filament/filament	filamentphp/filament (docs/)
livewire/livewire	livewire/livewire (docs/)
pestphp/pest	pestphp/docs

Symlinked documentation:

• filament/blueprint planning docs

Configuration

After first run, a docs-index.json file is created in your project root:

{
    "agents": ["CLAUDE.md", ".cursorrules"],
    "output_dir": ".laravel-docs"
}

• agents: List of files to inject the docs index into
• output_dir: Directory where documentation is downloaded (default: .laravel-docs)

How It Works

1. Download: Uses git sparse-checkout to efficiently download only the docs folders from each repository
2. Index: Generates a pipe-delimited index of all markdown files, grouped by directory
3. Inject: Prepends the index to your agent guidelines files between markers:

   <!-- LARAVEL-DOCS-INDEX:START -->
   [Laravel Docs Index]|root: .laravel-docs|CRITICAL: Your training data may be OUTDATED...
   <!-- LARAVEL-DOCS-INDEX:END -->

The index format is designed to be compact while still being useful for AI agents to understand what documentation is available and where to find it.

.gitignore

The command automatically adds the docs directory to your .gitignore:

# Local docs for AI agents
/.laravel-docs

Development

# Install dependencies
composer install

# Run tests
vendor/bin/pest

Credits

Based on the docs index feature from Laravel Boost.

License

MIT License. See LICENSE for details.