Download the PHP package laravelplus/commander without Composer

LaravelPlus Commander

A modern Laravel package for tracking and managing command executions with detailed analytics, beautiful UI, and comprehensive command management features.

📋 Requirements

• PHP: 8.4 or higher
• Laravel: 12.x or higher
• Vue.js: 3.x (included via CDN)
• Tailwind CSS: 3.x (included via CDN)

📦 Installation

Production Installation

For production projects, install via Composer:

Development Installation

For development or local projects, add to your composer.json:

Then run:

Setup Steps

1. Publish migrations and config:

2. Run migrations:

3. Access the interface:
   • Visit: http://your-app.com/admin/commander
   • Default URL can be configured in config/commander.php

⚙️ Configuration

The package is highly configurable through the config/commander.php file:

Basic Configuration

Command Management Configuration

🧪 Testing

The package includes comprehensive test coverage with 54 tests and 166 assertions:

Test Coverage

• ✅ Unit Tests: 51 tests covering all action classes, controllers, and services
• ✅ Feature Tests: 3 tests covering API endpoints and dashboard functionality
• ✅ Database Tests: Full database testing with SQLite in-memory database
• ✅ Mock Testing: Comprehensive mocking of dependencies
• ✅ Error Handling: Tests for all error scenarios and edge cases
• ✅ PHPUnit 11: Latest testing framework with improved performance

Test Structure

�� URL Configuration

You can customize the commander interface URL by setting the COMMANDER_URL environment variable:

✨ Features

🎯 Core Functionality

• ✅ Command Execution Tracking: Track when commands were last run with detailed metrics
• ✅ Execution History: View detailed history of all command executions with search and filtering
• ✅ Performance Analytics: Track execution times, success rates, and performance trends
• ✅ User Tracking: Track which user executed each command with audit trail
• ✅ Real-time Interface: Modern Vue 3 powered interface with real-time updates

🎨 User Interface

• ✅ Beautiful Modern UI: Clean, responsive design with Tailwind CSS
• ✅ Command Arguments Support: Dynamic forms for commands with arguments and options
• ✅ Confirmation Dialogs: Safety-first approach with confirmation before execution
• ✅ Improved Modals: Better modal design that doesn't get cut off
• ✅ Visual Indicators: Clear status indicators for command states
• ✅ Responsive Design: Works perfectly on desktop, tablet, and mobile

🔧 Command Management

• ✅ Disabled Commands: Mark commands as disabled (read-only) in the interface
• ✅ Excluded Commands: Completely hide commands from the interface
• ✅ Pattern Matching: Support for wildcard patterns in command filtering
• ✅ Command Categories: Organize commands by namespace/category
• ✅ Search & Filter: Powerful search and filtering capabilities

📊 Analytics & Monitoring

• ✅ Dashboard Statistics: Overview of command execution metrics
• ✅ Activity Monitoring: Real-time activity feed with filtering
• ✅ Failed Command Tracking: Dedicated interface for failed commands
• ✅ Retry Functionality: Retry failed commands with original parameters
• ✅ Schedule Management: Interface for managing scheduled commands

⚙️ Configuration & Security

• ✅ Highly Configurable: Extensive configuration options
• ✅ Security Features: CSRF protection, user authentication
• ✅ Output Storage: Store command output with configurable limits
• ✅ Retention Policy: Automatic cleanup of old execution records
• ✅ Environment Support: Different settings for different environments

🎯 Usage

Accessing the Interface

Once installed, you can access the commander interface at:

Interface Features

📋 Command List

• View all available commands with their descriptions
• See last execution time and status
• Filter by category or search by name
• Execute commands with confirmation dialog

⚙️ Command Arguments

• Dynamic forms for commands with arguments
• Support for required and optional arguments
• Default value handling
• Option flags and values

🔄 Execution History

• Detailed execution history for each command
• Success/failure status tracking
• Execution time and output storage
• User tracking for audit purposes

📊 Analytics Dashboard

• Overview of command execution metrics
• Success rate statistics
• Popular commands tracking
• Recent activity feed

❌ Failed Commands

• Dedicated interface for failed commands
• Retry functionality with original parameters
• Error analysis and debugging
• Bulk retry operations

⏰ Schedule Management

• Interface for managing scheduled commands
• Next run time calculations
• Schedule status monitoring
• Manual execution of scheduled commands

Helper Functions

The package provides helper functions for easy access:

Manual Tracking

You can also manually track command executions:

Querying Execution Data

🔌 API Endpoints

The package provides several API endpoints for managing command executions:

Get Commands with History

Returns all commands with their last execution time and statistics.

Get Command History

Returns paginated history of executions for a specific command.

Get Command Statistics

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

Pull Request Process

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Add tests for new functionality
5. Ensure all tests pass (php vendor/bin/phpunit)
6. Commit your changes (git commit -m 'Add some amazing feature')
7. Push to the branch (git push origin feature/amazing-feature)
8. Open a Pull Request

📄 License

This package is open-sourced software licensed under the MIT license.

🙏 Acknowledgments

• Built with Laravel 12+
• UI powered by Vue 3
• Styled with Tailwind CSS
• Testing with PHPUnit
• Requires PHP 8.4+

📞 Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Documentation: Wiki

Made with ❤️ by the LaravelPlus Team