A developer's understanding of consoles and how to give basic commands is relatively standard these days.
But what if you could enhance your process by coding your unique commands?
If we go back to Laravel 3, we may recall that it included tasks. Tasks were helpful, but they were insufficient for more complicated processes. Thankfully, Laravel 8 has a more powerful Artisan.
What Does It Mean To Be An Artisan?
Artisan is a command-line tool that debuted with Laravel 3.
You might not be aware of Artisan if you're not familiar with Laravel. Artisan is a command-line tool that debuted with Laravel 3. You may compare Artisan to Oil in FuelPHP, Many helpful commands are available in ZFTool in Zend, or the Console in Symfony 2. if you've used other frameworks.
Artisan's Console, which may assist you in accomplishing activities like creating migrations or publishing a package's assets, You may enhance Artisan with additional commands.
Artisan And Composer
A composer is a program that enables a user to construct any project based on a framework. It's made of all the libraries and dependencies.
Laravel's command-line interface is called Artisan. It contains a collection of instructions that will be discussed in-depth and will assist in developing a web application.
Artisan command syntax
php artisan [ options] [ arguments]
Some Basic Commands
php artisan list: This command will show all the available commands that are a part of laravel – artisan console.
Syntax of executing the command is
php artisan [command] [options] [arguments]where,
- options: It can be used like –h (for help), -q (for quiet), -v (for version) and many more.
- commands: It can be used as per command name followed by options and arguments. Some of the commands are make, help, serve, migrate etc.
E:\xampp\htdocs\mvendor>php artisan list
Laravel Framework 8.45.1
Usage:
command [options] [arguments]
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
--env[=ENV] The environment the command should run under
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
Available commands:
clear-compiled Remove the compiled class file
db Start a new database CLI session
down Put the application into maintenance / demo mode
env Display the current framework environment
help Display help for a command
inspire Display an inspiring quote
list List commands
migrate Run the database migrations
optimize Cache the framework bootstrap files
serve Serve the application on the PHP development server
test Run the application tests
tinker Interact with your application
ui Swap the front-end scaffolding for the application
up Bring the application out of maintenance mode
auth
auth:clear-resets Flush expired password reset tokens
cache
cache:clear Flush the application cache
cache:forget Remove an item from the cache
cache:table Create a migration for the cache database table
config
config:cache Create a cache file for faster configuration loading
config:clear Remove the configuration cache file
db
db:seed Seed the database with records
db:wipe Drop all tables, views, and types
event
event:cache Discover and cache the application's events and listeners
event:clear Clear all cached events and listeners
event:generate Generate the missing events and listeners based on registration
event:list List the application's events and listeners
key
key:generate Set the application key
make
make:cast Create a new custom Eloquent cast class
make:channel Create a new channel class
make:command Create a new Artisan command
make:component Create a new view component class
make:controller Create a new controller class
make:event Create a new event class
make:exception Create a new custom exception class
make:factory Create a new model factory
make:job Create a new job class
make:listener Create a new event listener class
make:mail Create a new email class
make:middleware Create a new middleware class
make:migration Create a new migration file
make:model Create a new Eloquent model class
make:notification Create a new notification class
make:observer Create a new observer class
make:policy Create a new policy class
make:provider Create a new service provider class
make:request Create a new form request class
make:resource Create a new resource
make:rule Create a new validation rule
make:seeder Create a new seeder class
make:test Create a new test class
migrate
migrate:fresh Drop all tables and re-run all migrations
migrate:install Create the migration repository
migrate:refresh Reset and re-run all migrations
migrate:reset Rollback all database migrations
migrate:rollback Rollback the last database migration
migrate:status Show the status of each migration
notifications
notifications:table Create a migration for the notifications table
optimize
optimize:clear Remove the cached bootstrap files
package
package:discover Rebuild the cached package manifest
queue
queue:batches-table Create a migration for the batches database table
queue:clear Delete all of the jobs from the specified queue
queue:failed List all of the failed queue jobs
queue:failed-table Create a migration for the failed queue jobs database table
queue:flush Flush all of the failed queue jobs
queue:forget Delete a failed queue job
queue:listen Listen to a given queue
queue:prune-batches Prune stale entries from the batches database
queue:restart Restart queue worker daemons after their current job
queue:retry Retry a failed queue job
queue:retry-batch Retry the failed jobs for a batch
queue:table Create a migration for the queue jobs database table
queue:work Start processing jobs on the queue as a daemon
route
route:cache Create a route cache file for faster route registration
route:clear Remove the route cache file
route:list List all registered routes
sail
sail:install Install Laravel Sail's default Docker Compose file
sail:publish Publish the Laravel Sail Docker files
schedule
schedule:list List the scheduled commands
schedule:run Run the scheduled commands
schedule:test Run a scheduled command
schedule:work Start the schedule worker
schema
schema:dump Dump the given database schema
session
session:table Create a migration for the session database table
storage
storage:link Create the symbolic links configured for the application
stub
stub:publish Publish all stubs that are available for customization
ui
ui:auth Scaffold basic login and registration views and routes
ui:controllers Scaffold the authentication controllers
vendor
vendor:publish Publish any publishable assets from vendor packages
view
view:cache Compile all of the application's Blade templates
view:clear Clear all compiled view files
php artisan help: This command is used to get help on a specific command. We can say it if you want to know more the meaning and usage of a particular command , you can easily get by use of help utility provided by artisan.
php artisan help make:eventwhere
- make: event: It is the command name for which we would like to know more.
- Out put of the above command is:
Description:
Create a new event class
Usage:
make:event
Arguments:
name The name of the class
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
--env[=ENV] The environment the command should run under
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
To see the Laravel framework version of a project:
php artisan -v
Thanks this article help me to solve my issue of how to create custom helper in laravel.