- How do I install Laraman in my Laravel project?
- Run `composer require christhompsontldr/laraman` in your project directory. The package integrates seamlessly with Laravel’s Artisan CLI and requires no additional configuration for basic usage. Ensure your project uses Laravel 8.x or 9.x, as the package hasn’t been updated for Laravel 10.x yet.
- Can Laraman work with Laravel 10.x or PHP 8.2+?
- Laraman’s last update was in 2020, so it may not fully support Laravel 10.x or PHP 8.2+. Test compatibility carefully, or consider forking the package to update dependencies like `laravelcollective/html` (abandoned) to modern alternatives. Check the GitHub issues for community patches.
- What kind of command examples does Laraman provide?
- Laraman offers tldr-style, concise examples for common Artisan commands like migrations, seeding, and queue jobs. Think of it as a cheat sheet for Laravel workflows—each example is copy-pasteable and tailored for quick execution. You can also add custom project-specific commands.
- How do I add my own custom command documentation?
- Laraman supports extensible pages via its configuration. Add custom YAML or JSON files in the `config/laraman` directory to define your own commands, workflows, or internal tooling. The package’s CLI will automatically include these in search results.
- Is Laraman suitable for production environments?
- Laraman is lightweight and designed for developer convenience, not production-critical operations. It’s ideal for internal docs, onboarding, or team workflows. Avoid using it for sensitive or high-traffic CLI interactions where reliability is paramount.
- Does Laraman support searching or filtering commands?
- Yes, Laraman includes a searchable CLI interface. Type `laraman` in your terminal to access a TUI (text-based UI) where you can filter commands by keyword, category, or usage. It’s optimized for speed, so results appear instantly.
- Are there alternatives to Laraman for Laravel CLI docs?
- For tldr-style docs, consider `shanks` (a general-purpose CLI helper) or manually curated Markdown files. For Laravel-specific solutions, explore `laravel-shift/blueprint` for scaffolding or `spatie/laravel-command-scheduler` for command management. Laraman’s niche is simplicity and Artisan focus.
- How do I test Laraman in my project before full adoption?
- Run `php artisan laraman:serve` to preview docs locally. Test edge cases like command chaining or custom inputs. Since it’s CLI-only, integration testing is minimal—focus on verifying examples match your Laravel setup (e.g., queue drivers, database connections).
- Will Laraman slow down my Laravel application?
- Laraman is passive and only active during CLI calls (e.g., `laraman`). It doesn’t interfere with HTTP requests or background jobs. However, if you add many custom pages, ensure your `config/laraman` files are optimized for parsing speed.
- Can Laraman integrate with Laravel’s testing tools (e.g., Pest or PHPUnit)?
- Laraman’s CLI commands can be tested via Artisan’s testing helpers (e.g., `Artisan::call('laraman')`). Mock the output or assert command execution in your test suite. Since it’s documentation-focused, unit tests aren’t critical, but integration tests for custom workflows are recommended.