Artisan Commands

Social Media Image Kit provides several Artisan commands to help setup, generate, and manage your social media images.

#Install Asset Container

The install-asset-container Artisan command may be used to create the asset container that will be used by Social Media Image Kit. It can be invoked by running the following command from the root of your project:

1php artisan social-media-image-kit:install-asset-container

You will be prompted to select the storage disk when creating the asset container using this command. This command should only be run once as part of the initial installation and setup process.

#Image Tasks Table

Some features, such as generating images on a job queue, will require a database. The sub-feature to prevent duplicate jobs from being created will also require an additional table to be created. The image-tasks-table Artisan command may be used to add the required migration to your project.

1php artisan social-media-image-kit:image-tasks-table

After the command has finished, you should see a new migration created in your site's database/migrations folder.

#Generate Images

The generate-images Artisan command may be used to generate images for all configured collections. It can be invoked by running the following command from the root of your project:

1php artisan social-media-image-kit:generate-images

This command will only generate missing images by default. If you've made substantial changes to your template, or want to regenerate all social media images add the --regen flag:

1php artisan social-media-image-kit:generate-images --regen

This command can take a long time to complete if you have a large number of entries and social media image profiles.