English | 中文 | 繁體中文 | 日本語 | 한국어 | Français | Español | Deutsch | Italiano | Русский | Português (Brasil)
Laravel Docs Reader is an OpenClaw Agent Skill that gives agents (and developers) instant access to accurate, version-aware Laravel documentation. No more guessing — the agent looks up the official docs before writing a single line of code.
- 🔍 Natural Language CLI Search —
php laradoc.php search "how to create a queue job"— works like asking the docs directly - 📦 Local Doc Cache — docs bundled in the skill for offline, instant access; no internet required after first run
- 🔄 Auto Version Detection — detects your project's Laravel version (10/11/12) and serves the right docs
- 📖 Full Documentation Coverage — routing, controllers, models, queues, mail, auth, events, broadcasting, testing, and more
- 🏭 Code Generation — generates PSR-12 compliant Laravel code skeletons
- 📊 Version Diff — highlights what changed across Laravel 10 / 11 / 12
- 📋 PSR-12 Quick Reference — built-in, no external tool needed:
php laradoc.php psr,psr arrays,psr naming - 🤖 Auto-Update via PR — GitHub Actions workflow watches for new Laravel releases and auto-creates a PR to update this skill
- 🔗 Laravel Package Search — after every search result, the agent suggests
laravel-package-searchfor third-party package discovery
# ── Core Search ──────────────────────────────────────────────
# Natural language search — ask the docs anything
php laradoc.php search "how to create a middleware"
php laradoc.php search "how to send a notification"
php laradoc.php search "queue job with retry and failure handling"
php laradoc.php search "redis cache with tags"
# ← Shows Package Search cross-link after every result
# ── Version ──────────────────────────────────────────────────
php laradoc.php version # auto-detect current project
php laradoc.php version /path/to/project # specific project
php laradoc.php current # show default (Laravel 12)
# ── Config & Facades ─────────────────────────────────────────
php laradoc.php config database
php laradoc.php config cache
php laradoc.php config mail
php laradoc.php facade Cache
php laradoc.php facade DB
php laradoc.php facade Route
# ── Artisan & Diff ───────────────────────────────────────────
php laradoc.php artisan make:controller
php laradoc.php artisan migrate
php laradoc.php diff auth # Laravel 10 vs 11 vs 12
php laradoc.php diff routing
# ── Code Generation ──────────────────────────────────────────
php laradoc.php generate controller UserController
php laradoc.php generate model Post
php laradoc.php generate job ProcessUpload
php laradoc.php generate request StorePostRequest
php laradoc.php generate notification InvoicePaid
# ── Blade Directives ─────────────────────────────────────────
php laradoc.php lang "loop"
php laradoc.php lang "csrf"
# ── PSR-12 Quick Reference ───────────────────────────────────
php laradoc.php psr # Full PSR-12 summary table
php laradoc.php psr arrays # Arrays rule only
php laradoc.php psr naming # Naming conventions
php laradoc.php psr methods # Visibility & method rules
# ── Cache & Update ────────────────────────────────────────────
php laradoc.php cache # Show cache status (offline OK)
php laradoc.php update # Force-refresh from GitHub
php laradoc.php subscribe # Show subscription / auto-update statusThe CLI auto-detects your project's Laravel version:
composer.json→laravel/frameworkartisan --versionvendor/laravel/framework/.../Application.php→VERSION
If no project found, defaults to Laravel 12.
This skill stays current automatically:
- Weekly check: A GitHub Actions workflow runs every Sunday at 00:00 UTC
- New version detection: Compares Packagist's
laravel/frameworklatest version - Auto-PR: If a new Laravel version is detected, the workflow creates a PR updating the skill's references
# .github/workflows/update-docs.yml
on:
schedule:
- cron: '0 0 * * 0' # Weekly on Sunday
workflow_dispatch: # Manual triggerAnyone using this skill can review the auto-generated PR before merging — no surprises.
| Category | Topics |
|---|---|
| Routing | Basic routes, groups, resource, named, middleware |
| Controllers | CRUD, REST, API, single-action, DI |
| Models | Eloquent, all 12 relationship types, scopes, casts |
| Migrations | Schema builder, foreign keys, indexes |
| Validation | Form requests, inline, custom rules |
| Auth | Breeze, Sanctum, Gates, Policies |
| Queues | Jobs, dispatching, Horizon |
| Cache | Store API, Redis tags, locks |
| Markdown, attachments, queuing | |
| Notifications | Multi-channel, database |
| Testing | Pest, factories, fakes, HTTP tests |
| Events | Listeners, broadcasting |
| Storage | Local/S3, signed URLs |
| Scheduling | Cron, overlapping prevention |
| Container | Binding, singletons |
| Facades | 30+ facade method signatures |
| Broadcasting | Private/public channels |
When activated, the skill:
- Detects project Laravel version (or uses default 12)
- Maps your request to the correct doc section
- Returns: summary + code example + version notes + best practices
git clone https://github.com/relunctance/laravel-docs-reader.git
cd laravel-docs-reader
php scripts/laradoc.php search "how to create a middleware"This is an OpenClaw Agent Skill.
clawhub install laravel-docs-reader
# or
clawhub login --token <YOUR_TOKEN> && clawhub publish laravel-docs-readerlaravel-docs-reader/
├── SKILL.md # Skill specification
├── README.md # English (this file)
├── README.zh-CN.md # Chinese
├── .github/workflows/
│ └── update-docs.yml # Auto-update PR (weekly)
├── .cache/ # Local doc cache (auto-created)
├── references/
│ ├── version-detection.md # Version detection logic
│ ├── version-diff.md # Laravel 10/11/12 diff
│ ├── psr-12.md # PSR-12 quick reference
│ ├── api-index.md # Full API reference
│ ├── artisan-commands.md # All artisan commands
│ ├── facades.md # Facade method signatures
│ ├── blade-directives.md # All Blade directives
│ ├── config-ref.md # config/ reference
│ └── examples/
│ ├── controller.md
│ ├── model.md
│ ├── migration.md
│ ├── middleware.md
│ ├── queue-job.md
│ ├── notification.md
│ └── testing.md
└── scripts/
└── laradoc.php # CLI tool (14 commands)
Found outdated content or missing docs?
- Open an issue: https://github.com/relunctance/laravel-docs-reader/issues
- Or submit a PR directly
MIT License