Hiding Laravel Artisan Console Commands from the list of available commands

Published on by

Hiding Laravel Artisan Console Commands from the list of available commands image

When you are releasing products or packages to the world sometimes you may have some Artisan Console commands that are only used for installation, or other special circumstances that you don’t want to expose in the list when someone runs php artisan.

Hiding Using the Command hidden property

Laravel makes has a simple way to hide a command by setting a hidden property on the command class like this:

class DestructiveCommand extends Command
{
protected $signature = 'db:resetdb';
protected $description = 'DESTRUCTIVE! do not run this unless you know what you are doing';
 
// Hide this from the console list.
protected $hidden = true;

Hiding Using the setHidden method

If you’d like to take this a step further Brian Dillingham shared a great tip on Twitter on how to do this programmatically using the setHidden method:

✨Laravel Package Tip: Hide your install commands from php artisan after installed to keep things tidy. pic.twitter.com/o4PK8xXkIk

— Brian Dillingham (@im_brian_d) January 2, 2021

Here is a more copy/paste friendly version of the code in his screenshot:

class Install extends Command
{
protected $signature = 'package:install';
protected $description = 'Install Package';
 
public function __construct()
{
parent::__construct();
if (file_exists(config_path('package.php'))) {
$this->setHidden(true);
}
}

With either of these set your console command will no longer show when running php artisan in the console, of course, someone can still run it manually if they know the signature so this is only useful for hiding in the list, not from stopping it from actually running.

Eric L. Barnes photo

Eric is the creator of Laravel News and has been covering Laravel since 2012.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Tinkerwell

Version 4 of Tinkerwell is available now. Get the most popular PHP scratchpad with all its new features and simplify your development workflow today.

Visit Tinkerwell
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. We ♥ Laravel

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
Larafast: Laravel SaaS Starter Kit logo

Larafast: Laravel SaaS Starter Kit

Larafast is a Laravel SaaS Starter Kit with ready-to-go features for Payments, Auth, Admin, Blog, SEO, and beautiful themes. Available with Vue and Livewire stacks.

Larafast: Laravel SaaS Starter Kit
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector

The latest

View all →
Audit MySQL Databases in Laravel With the DB Auditor Package image

Audit MySQL Databases in Laravel With the DB Auditor Package

Read article
The Ability to Prevent Destructive Commands From Running is Coming to Laravel 11 image

The Ability to Prevent Destructive Commands From Running is Coming to Laravel 11

Read article
Configuring Laravel With Additional Environment Files image

Configuring Laravel With Additional Environment Files

Read article
Real Time Command Line Monitoring With Laravel Top image

Real Time Command Line Monitoring With Laravel Top

Read article
A New Validation Rule and the Ability to Manually Fail a Command in Laravel 11.8 image

A New Validation Rule and the Ability to Manually Fail a Command in Laravel 11.8

Read article
New Array Find Functions in PHP 8.4 image

New Array Find Functions in PHP 8.4

Read article