PHPackages toneflix-code/laravel-visualconsole - 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. [CLI & Console](/categories/cli) 4. / 5. toneflix-code/laravel-visualconsole ActiveLibrary[CLI & Console](/categories/cli) toneflix-code/laravel-visualconsole =================================== A Laravel package to help with frequent artisan tasks and more. 2.0.1(1y ago)254MITBladePHP ^8.0|^8.1|^8.2 Since Oct 4Pushed 1y agoCompare [ Source](https://github.com/toneflix/laravel-visualconsole)[ Packagist](https://packagist.org/packages/toneflix-code/laravel-visualconsole)[ Docs](https://github.com/toneflix-code/laravel-visualconsole)[ RSS](/packages/toneflix-code-laravel-visualconsole/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (9)Versions (14)Used By (0) Laravel Visual Console ====================== [](#laravel-visual-console) [![Latest Version on Packagist](https://camo.githubusercontent.com/f961e8e420739dc6e9acf93d89487ed1a2bf637bdd4e11cfcc993c6473a9a9d0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f746f6e65666c69782d636f64652f6c61726176656c2d76697375616c636f6e736f6c652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/toneflix-code/laravel-visualconsole)[![Total Downloads](https://camo.githubusercontent.com/3f654f14d5e289c3fee5fc6bc5cac5eb94d169172a7f3cd0c2ab6ac6ba73bc84/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f746f6e65666c69782d636f64652f6c61726176656c2d76697375616c636f6e736f6c652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/toneflix-code/laravel-visualconsole) Laravel Visual Console is designed to give you a visual experience of your most frequent Laravel processes, artisan commands, and system management. This could come in really handy if you build and manage APIs that don't require you to build any additional user interfaces. [![preview](https://user-images.githubusercontent.com/52163001/210129782-1c701a9f-6de6-4e00-9a9a-bc731d7965c2.png)](https://user-images.githubusercontent.com/52163001/210129782-1c701a9f-6de6-4e00-9a9a-bc731d7965c2.png) Installation ------------ [](#installation) You can install the package via composer: ``` composer require toneflix-code/laravel-visualconsole ``` Post Installation ----------------- [](#post-installation) After installation you must publish the package assets by running: ``` php artisan vendor:publish --tag=visualconsole-assets ``` Optionally you can publish the configuration file by running: ``` php artisan vendor:publish --tag=visualconsole-config ``` You can also optionally publish the views by running: ``` php artisan vendor:publish --tag=visualconsole-view ``` If needed, you can also publish the routes by running: ``` php artisan vendor:publish --tag=visualconsole-routes ``` Getting Google Keys ------------------- [](#getting-google-keys) This package depends on google drive for backup storage, although you can use any storage your spp is configured to run with. #### Please follow [Google Docs](https://developers.google.com/drive/v3/web/enable-sdk) to obtain your `client ID, client secret & refresh token` which is required to get the system running. [](#please-follow-google-docs-to-obtain-your-client-id-client-secret--refresh-token-which-is-required-to-get-the-system-running) #### In addition you can also check these easy-to-follow tutorial by [@ivanvermeyen](https://github.com/ivanvermeyen/laravel-google-drive-demo) [](#in-addition-you-can-also-check-these-easy-to-follow-tutorial-by-ivanvermeyen) - [Getting your Client ID and Secret](https://github.com/ivanvermeyen/laravel-google-drive-demo/blob/master/README/1-getting-your-dlient-id-and-secret.md) - [Getting your Refresh Token](https://github.com/ivanvermeyen/laravel-google-drive-demo/blob/master/README/2-getting-your-refresh-token.md) Usage ----- [](#usage) After installation, the package is ready to use, simply point your browser to . The default setup is configured to work with your current authentication model. ### Authorization [](#authorization) By default, the package will check the `privileges` field of the current authentication model `[User]` for if the authenticating user has the `admin` Privilege assuming the value of the field is a numeric list of attributes/privileges, if it fails to confirm it checks if the value of the field is exactly `admin`, once confirmed the user is authenticated. If you which to change the behaviour you should check the [Post Installation](#post-installation) section for how to publish the config and modify it to suit your requirements, you can also set the `permission_field` and `permission_value` config values to `null` in order to disable this behaviour. Disabling the feature implies that anyone with log in access can also access the visual console. ### Custom Commands [](#custom-commands) The library also exposes a few custom Artisan commands to help you with certain everyday tasks, even though these commandsa are accessible through the UI, they are still Artisan commands and are as much accessible through your terminal. 1. `system:deploy`: Automatically deploys the latest code from the git repository associated with your project. Before you run this command, make sure you have set up a git repository and have added a remote named "origin". - ARGUMENTS 1. `--branch=`: The branch to deploy, the default is `main`. 2. `--force`: Force the deployment. 3. `--dev`: Run in development mode (This will prevent composer from removing dev dependencies) 4. `--log-level=[level]`: How log the output should handled. `0` = none, `1` = console only, `2` = file and console. 5. `--mock-php`: If your server is on a shared hosting which uses a different version on the CLI less that php 8.1, this option allows you to use a different version of php of your choice, publish the [config file](#post-installation) and update the `php_bin` option or set `VISUALCONSOLE_PHP_BINARY` option on your .env file (Make sure the path is an abosolute path to your prefered php binary). You can also set the `composer` option or set the `VISUALCONSOLE_COMPOSER` option on your .env. 6. `--composer=[command]` Allows you to run a custom composer command, this is useful if you want to run a composer command before the deployment. E.g. `--composer="install --no-dev"`. For now this option only supports the `install` and `update` commands only. 7. `--ensure-commit`: Make sure there are no uncommitted changes before deployment. Example: ``` php artisan system:deploy --branch=main ``` 2. `system:control`: Helps you perforom common system tasks like backup, backup restore and system reset. - PARAMETERS 1. `action` The specific action to carryout \[reset, backup, restore\] - ARGUMENTS 1. `--w|wizard`: Let the wizard guide you through the whole process. 2. `--r|restore`: Restore the system to the last backup or provide the `--signature` option to restore to a known backup signature. 3. `--s|signature=`: Set the backup signature value to restore a particular known backup. E.g. `2022-04-26_16-05-34`. 4. `--b|backup`: During system reset, do a complete system backup before the reset. 5. `--d|delete`: If the restore option is set, this option will delete the backup files after successfull a restore. 6. `--f|force`: Force the action to execute. Example: ``` php artisan system:control backup --w|wizard ``` 3. `system:key-gen`: Generate a webhook secret key for the application, you can use this key for authorizing github or any other services where you need access tho the artisan webhook interface. Example: ``` php artisan system:key-gen ``` ### Artisan Webhook Interface [](#artisan-webhook-interface) The Artisan Webhook Interface allows you to remotely run any of the given artisan commands listed above where user authentication is not possible. The interface can be accessed like this: `http://youdomainexample.com/system/webhooks/artisan/[command [--param1] [--param2]]`. When accessing this endpoint, you will have to pass the HMAC hex digest of the request body, generated using the SHA-1 or SHA-256 hash function and the secret as the HMAC key through the `X-Hub-Signature` header for Github or the `X-Signature` for other services, provided for convinience purpose. ### Queues and Failed Jobs [](#queues-and-failed-jobs) The library currently supports the database connection for queued jobs. ### Testing [](#testing) ``` composer test ``` ### Changelog [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. ### Security [](#security) If you discover any security-related issues, please email instead of using the issue tracker. Credits ------- [](#credits) - [Toneflix Code](https://github.com/toneflix-code) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 32 — LowBetter than 72% of packages Maintenance33 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community6 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor1 Top contributor holds 100% 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 Every ~55 days Recently: every ~143 days Total 13 Last Release 658d ago Major Versions 0.0.9 → 1.0.02023-01-04 1.0.1 → 2.0.02024-01-16 PHP version history (2 changes)0.0.1PHP ^8.0|^8.1 2.0.0PHP ^8.0|^8.1|^8.2 ### Community Maintainers ![](https://www.gravatar.com/avatar/4638f9de973d94753ebff641af3009e1049064f9a6bd76fe87e58d0d8ddd7ca7?d=identicon)[3m1n3nc3](/maintainers/3m1n3nc3) --- Top Contributors [![3m1n3nc3](https://avatars.githubusercontent.com/u/52163001?v=4)](https://github.com/3m1n3nc3 "3m1n3nc3 (36 commits)") --- Tags toneflix-codelaravel-visualconsole ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/toneflix-code-laravel-visualconsole/health.svg) ``` [![Health](https://phpackages.com/badges/toneflix-code-laravel-visualconsole/health.svg)](https://phpackages.com/packages/toneflix-code-laravel-visualconsole) ``` ### Alternatives [aedart/athenaeum Athenaeum is a mono repository; a collection of various PHP packages 245.2k](/packages/aedart-athenaeum)[sunaoka/laravel-facade-generator Provide command line generation of facade layer files. 171.9k](/packages/sunaoka-laravel-facade-generator) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)