CLI Artisan Laravel

Muhammad Fajri
Monday, 05 April 2021

Bismillahirrahmanirrahim.

Artisan merupakan perintah berbasis console / Command Line Interface (CLI) yang disertakan dengan Laravel. Artisan berada di direktori root dari aplikasi sebagai skrip artisan dan menyediakan sejumlah perintah yang sangat membantu dalam proses pengembangan aplikasi.

Untuk melihat semua daftar perintah artisan jalankan perintah:

php artisan list

php sendiri untuk memanggil PHP karena artisan berbasiskan PHP, artisan perintah untuk memanggil artisan itu sendiri, dan list untuk melihat daftar perintah dari artisan CLI.

Berikut daftar perintah yang ada dalam penggunaan CLI.

Laravel Framework 8.35.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            Force ANSI output
      --no-ansi         Disable 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
  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
 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

Setiap perintah Artisan memiliki juga memiliki layar bantuan untuk melihat detail penggunaan lengkapnya. Untuk melihat bantuan, tambahkan perintah help, seperti:

php artisan help migrate

Perintah yang Sangat Berguna

  • php artisan serve, perintah yang digunakan untuk menjalankan aplikasi pada localhost.
  • php artisan key:generate, perintah untuk men-generate string random yang digunakan untuk encrypt-decrypt pada aplikasi. Misal proses session, CSRF Token, sign url, dsb. Untuk melihat perubahan dari sebagai hasil dari perintah ini yaitu pada file .env di bagian APP_KEY. Contoh isinya seperti: 
    APP_NAME=Laravel
APP_ENV=local
APP_KEY=base64:oc9NFz16WwSvdrtzHDVt7fyObm0JxnZML3ZSoVHVep0=
APP_DEBUG=true
APP_URL=http://blog.test
  • php artisan make:controller <ControllerName>, perintah untuk men-generate file controller yang akan ditempatkan di folder Http/controller.
  • php artisan make:model <ModelName>, perintah untuk men-generate file model yang akan ditempatkan di folder App.
  • php artisan make:migration <MigrationName>, perintah untuk men-generate file migration yang akan ditempatkan di folder database\migrations.

Itulah pengenalan mengenai Artisan CLI, perintah-perintah yang ada dan juga diberikan paparan singkat mengenai perintah Artisan CLI yang sangat berguna dalam proses pengembangan aplikasi berbasis Laravel.

Referensi