›
›
›
  1. docs
  2. ›
  3. byrcsc/laravel-whitelabel
1.x
Browse documentationOpenClose

Getting started

  • Introduction
  • Installation and setup
  • Quick start

Core concepts

  • Brand definitions
  • Fallback and clearing
  • Brand resolution
  • Brand repositories

Using brands

  • Blade components
  • Mail and notifications
  • Queues
  • Spatie Multitenancy

Operations

  • Manage database brands
  • Custom drivers and resolvers
  • Events and listeners
  • Cache management

Reference

  • Configuration
  • Public API
  • Console commands
  • Testing
  • Troubleshooting

Getting started

  • Introduction
  • Installation and setup
  • Quick start

Core concepts

  • Brand definitions
  • Fallback and clearing
  • Brand resolution
  • Brand repositories

Using brands

  • Blade components
  • Mail and notifications
  • Queues
  • Spatie Multitenancy

Operations

  • Manage database brands
  • Custom drivers and resolvers
  • Events and listeners
  • Cache management

Reference

  • Configuration
  • Public API
  • Console commands
  • Testing
  • Troubleshooting

byrcsc/laravel-whitelabel · 1.x

Console commands.

Reference installation and cache maintenance commands with all supported options.

Laravel Whitelabel registers two Artisan commands. Use the installer to publish package files and the clear command to invalidate repository caches.

whitelabel:install

php artisan whitelabel:install [--database] [--force]

The command always attempts to publish config/whitelabel.php. In an interactive terminal it asks whether to publish the brands migration unless a migration is already present.

OptionBehavior
--databasePublish the brands migration without prompting
--forceOverwrite published config and migration files

In non-interactive use, the migration is skipped unless --database is present:

php artisan whitelabel:install --database --no-interaction

Without --force, running the command again leaves existing config and migration files unchanged. The command reports those files as already present. After publishing the migration, it tells you to run php artisan migrate and select the database driver.

The command exits with success when all requested files exist after publishing. It exits with failure if a requested file could not be published.

whitelabel:clear

php artisan whitelabel:clear

With a cached database or custom driver, the command deletes every registered brand entry, the domain index, and the package's key registry. It then flushes the inner driver. Other application cache keys remain untouched.

With the config driver or cache disabled, the command exits successfully and reports that the configured driver caches nothing.

What to read next

  • Installation and setup for the complete install sequence.
  • Cache management for cache keys and invalidation behavior.
  • Configuration to select the database driver and cache store.
PreviousPublic APINextTesting
View source

On this page

  1. whitelabel:install
  2. whitelabel:clear
  3. What to read next