PHPackages                             leek/laravel-docs-index - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. leek/laravel-docs-index

ActiveLibrary[Utility & Helpers](/categories/utility)

leek/laravel-docs-index
=======================

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

v0.0.1(2mo ago)3945↓27.8%MITPHPPHP ^8.2

Since Feb 22Pushed 2mo agoCompare

[ Source](https://github.com/leek/laravel-docs-index)[ Packagist](https://packagist.org/packages/leek/laravel-docs-index)[ RSS](/packages/leek-laravel-docs-index/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (6)Versions (3)Used By (0)

Laravel Docs Index
==================

[](#laravel-docs-index)

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
------------

[](#installation)

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

The package will auto-register with Laravel.

Usage
-----

[](#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

[](#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
------------------

[](#supported-packages)

The following packages are automatically detected and their documentation downloaded:

PackageDocumentation Source`laravel/framework`[laravel/docs](https://github.com/laravel/docs)`filament/filament`[filamentphp/filament](https://github.com/filamentphp/filament) (docs/)`livewire/livewire`[livewire/livewire](https://github.com/livewire/livewire) (docs/)`pestphp/pest`[pestphp/docs](https://github.com/pestphp/docs)Symlinked documentation:

- `filament/blueprint` planning docs

Configuration
-------------

[](#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
------------

[](#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]|root: .laravel-docs|CRITICAL: Your training data may be OUTDATED...

    ```

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
----------

[](#gitignore)

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

```
# Local docs for AI agents
/.laravel-docs

```

Development
-----------

[](#development)

```
# Install dependencies
composer install

# Run tests
vendor/bin/pest
```

Credits
-------

[](#credits)

Based on the docs index feature from [Laravel Boost](https://github.com/laravel/boost).

License
-------

[](#license)

MIT License. See [LICENSE](LICENSE) for details.

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance86

Actively maintained with recent releases

Popularity24

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity37

Early-stage or recently created project

 Bus Factor1

Top contributor holds 85.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

60d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e11ad2f75cb1d558136f1982458d541d96fb84a217d6a82e8c18df2ff503964b?d=identicon)[leek](/maintainers/leek)

---

Top Contributors

[![leek](https://avatars.githubusercontent.com/u/60204?v=4)](https://github.com/leek "leek (6 commits)")[![Copilot](https://avatars.githubusercontent.com/in/1143301?v=4)](https://github.com/Copilot "Copilot (1 commits)")

---

Tags

laravelaicursoragentsclaudedocswindsurf

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/leek-laravel-docs-index/health.svg)

```
[![Health](https://phpackages.com/badges/leek-laravel-docs-index/health.svg)](https://phpackages.com/packages/leek-laravel-docs-index)
```

###  Alternatives

[wnx/laravel-stats

Get insights about your Laravel Project

1.8k1.8M7](/packages/wnx-laravel-stats)[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k36.7M259](/packages/laravel-dusk)[laravel-zero/framework

The Laravel Zero Framework.

3371.4M369](/packages/laravel-zero-framework)[mischasigtermans/laravel-altitude

Claude Code agents for the TALL stack, powered by Laravel Boost

1139.2k](/packages/mischasigtermans-laravel-altitude)[laragear/preload

Effortlessly make a Preload script for your Laravel application.

119363.5k](/packages/laragear-preload)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)