Weave Code
Cli Laravel Package
pomm-project/cli
Command-line tools for Pomm, the PostgreSQL ORM for PHP. Provides a CLI to help generate and manage models, schemas and project scaffolding, automate database-related tasks, and speed up development workflows from the terminal.
Command line for Pomm.
Frequently asked questions about Cli
- Can I use pomm-project/cli for PostgreSQL database management in a Laravel application?
- Yes, but with caveats. Pomm CLI is designed for PostgreSQL and can inspect schemas, relations, and generate models. However, it’s not a direct Laravel package—you’ll need to integrate it via Symfony Process or custom Artisan commands to bridge its functionality into Laravel’s workflow. It’s ideal if your app already uses Pomm for PostgreSQL operations.
- How do I install and configure pomm-project/cli in a Laravel project?
- Install via Composer: `composer require pomm-project/cli`. Configure it by creating a `.pomm_cli_bootstrap.php` file that returns a Pomm instance. If you already have a Pomm configuration script, use the `-b|--bootstrap-file` flag to point to it. No Laravel-specific setup is required, but you’ll need to wrap CLI commands in Artisan or Symfony Process for Laravel integration.
- Does pomm-project/cli support Laravel’s Artisan commands?
- No, it doesn’t natively integrate with Artisan. However, you can create custom Artisan commands to execute Pomm CLI tasks (e.g., `pomm:inspect:database`) using Symfony Process. This allows you to trigger Pomm CLI functionality from Laravel’s command line while maintaining security and avoiding direct shell execution.
- What Laravel versions and PHP versions does pomm-project/cli support?
- Pomm CLI itself doesn’t enforce Laravel version constraints, but it depends on Pomm (pomm-project/pomm), which requires PHP 7.4+. Laravel 9+ (PHP 8.0+) may need additional checks for compatibility. Always pin Pomm’s version in `composer.json` to avoid conflicts. Test thoroughly in your Laravel environment.
- Is pomm-project/cli safe to use in production? Are there security risks?
- Yes, but avoid direct shell execution (e.g., `shell_exec()`) due to command injection risks. Use Symfony Process or a secure facade to invoke Pomm CLI commands. For production, also validate inputs and restrict CLI access to trusted environments. Wrapping commands in Artisan adds an extra layer of security.
- Can I use pomm-project/cli for Laravel queue management if I’m using Pomm for messaging?
- Yes, if your Laravel app uses Pomm for message queues (e.g., AMQP). Pomm CLI provides commands like `pomm:consume` and `pomm:publish` for queue operations. However, this replaces or supplements Laravel’s native queue system. Ensure your team is familiar with Pomm’s CLI-driven workflow, as it diverges from Laravel’s Artisan-centric approach.
- What are the alternatives to pomm-project/cli for PostgreSQL management in Laravel?
- For PostgreSQL management in Laravel, consider Laravel-specific tools like `laravel-shift/database` or `spatie/laravel-postgres`. For CLI-driven database tasks, `doctrine/dbal` or `laravel/scout` (for search) may fit better. If you’re using Pomm for messaging, its CLI is the most aligned option, but it lacks Laravel-native integration.
- How do I generate models or schemas using pomm-project/cli in Laravel?
- Pomm CLI doesn’t generate Laravel Eloquent models directly, but it can inspect PostgreSQL schemas and relations. Use commands like `pomm:inspect:schema` to analyze your database structure. For model generation, you’ll need to manually create Laravel models or use a tool like `laravel-shift/database` and sync it with Pomm’s schema insights.
- Will pomm-project/cli work with Laravel’s migrations or seeders?
- No, Pomm CLI is independent of Laravel’s migrations or seeders. It focuses on PostgreSQL schema inspection and Pomm-specific operations. For migration-like tasks, use Laravel’s native tools (`php artisan migrate`). Pomm CLI can complement this by providing database insights, but it won’t replace Laravel’s migration system.
- How do I test pomm-project/cli in a Laravel testing environment?
- Test Pomm CLI in Laravel by mocking its output or using Symfony Process in your tests. For example, create a test Artisan command that calls `pomm:inspect:database` and assert the output. Avoid direct CLI execution in tests; instead, use Laravel’s testing helpers or mock the Process class to simulate Pomm CLI behavior.
Weaver
How can I help you explore Laravel packages today?