wirechat:install

Install WireChat package and publish necessary files

Overview

The wirechat:install command sets up WireChat in your Laravel application by publishing configuration files, migrations, and creating a default chat panel.

Command Signature

php artisan wirechat:install

What It Does

The installation command performs the following operations:

1. Publish Configuration

   Publishes the wirechat.php configuration file to your config directory. If the file already exists, you’ll be prompted to confirm overwriting it.

2. Create Storage Symlink

   Creates a symbolic link from public/storage to storage/app/public for file attachments.

3. Publish Migrations

   Publishes database migration files for conversations, messages, participants, and other WireChat tables.

4. Create Default Panel

   Automatically creates a default chat panel with the ID chats by calling make:wirechat-panel.

Interactive Prompts

Existing Configuration

If a configuration file already exists at config/wirechat.php, you’ll see:

Config file already exists. Do you want to overwrite it? (yes/no) [no]

Overwriting the configuration file will replace all your custom settings. Back up your configuration before overwriting.

Example Output

$ php artisan wirechat:install

Installing Wirechat Package...
Publishing configuration...
[✓] Published configuration
Creating storage symlink...
[✓] Storage linked.
Publishing migrations...
[✓] Published migrations

 What is the panel ID?: chats

Wirechat panel [App\Providers\Wirechat\ChatsPanelProvider] created successfully.
We've tried to add [app/Providers/Wirechat/ChatsPanelProvider.php] into your [bootstrap/providers.php] file.

[✓] Wirechat Package installed successfully.

Next Steps

After installation:

1. Run migrations to create database tables:

   php artisan migrate
   

2. Configure your panel provider in app/Providers/Wirechat/ChatsPanelProvider.php

3. (Optional) Set up push notifications:

   php artisan wirechat:setup-notifications
   

Files Published

config/wirechat.php · file

Main configuration file for WireChat settings (legacy, panel-based configuration recommended)

database/migrations · directory

Migration files for all WireChat database tables

app/Providers/Wirechat/ChatsPanelProvider.php · file

Default panel provider for customizing chat functionality

Source Reference

Command implementation: ~/workspace/source/src/Console/Commands/InstallWirechat.php:11