October CMS includes several command-line interface (CLI) commands and utilities that allow you to manage various aspects of the platform, as well as speed up the development process. The console commands are based on Laravel's Artisan tool. You may develop your own console commands or speed up development with the provided scaffolding commands.
The october:update command will request updates from the October gateway. It will update the core application and plugin files, then perform a database migration.
php artisan october:update
The october:migrate command will perform a database migration, creating database tables and executing seed scripts, provided by the system and plugin version history. The migration command can be run multiple times, it will only execute a migration or seed script once, which means only new changes are applied.
php artisan october:migrate
The --rollback option will reverse all migrations, dropping database tables and deleting data. Care should be taken when using this command. The plugin refresh command is a useful alternative for debugging a single plugin.
php artisan october:migrate --rollback
The october:passwd command allows the password of a backend administrator to be changed via the command line. This is useful if you are locked out of your October CMS install, or for changing the password for the default administrator account.
php artisan october:passwd username password
For the first argument you may pass either the login name or email address. For the second argument you may optionally pass the desired password, otherwise you will be prompted to enter one.
October CMS includes these commands for managing your project.
project:sync installs all plugins and themes belonging to a project.
php artisan project:sync
project:set sets the license key for the current installation.
php artisan project:set <license key>
October CMS includes a number of commands for managing plugins.
plugin:install - downloads and installs the plugin by its name. The next example will install a plugin called AuthorName.PluginName.
php artisan plugin:install AuthorName.PluginName
You may install a plugin from a remote source using the --from option.
php artisan plugin:install AuthorName.PluginName [email protected]:authorname/pluginname-plugin.git
Use the --want option to specify a target branch or version.
php artisan plugin:install AuthorName.PluginName [email protected]:authorname/pluginname-plugin.git --want=dev-develop
Use the --oc option if your package name has the oc prefix.
php artisan plugin:install AuthorName.PluginName [email protected]:authorname/pluginname-plugin.git --oc
plugin:check - performs a system wide check of installed plugin dependencies. This command will spin over every theme and plugin that is currently installed and check to see if its dependencies are also installed. If it finds any missing requirements, it will attempt to install them.
php artisan plugin:check
plugin:refresh - destroys the plugin's database tables and recreates them. This command is useful for development.
php artisan plugin:refresh AuthorName.PluginName
plugin:rollback - Rollback the specified plugin's migrations. The second parameter is optional, if specified the rollback process will stop at the specified version.
php artisan plugin:rollback AuthorName.PluginName 1.2.3
plugin:list - Displays a list of installed plugins and their version numbers.
php artisan plugin:list
plugin:disable - Disable an existing plugin.
php artisan plugin:disable AuthorName.PluginName
plugin:enable - Enable a disabled plugin.
php artisan plugin:enable AuthorName.PluginName
plugin:remove - destroys the plugin's database tables and deletes the plugin files from the filesystem.
php artisan plugin:remove AuthorName.PluginName
October includes a number of commands for managing themes.
theme:install - download and install a theme from the Marketplace. The following example will install the theme in /themes/authorname-themename
php artisan theme:install AuthorName.ThemeName
You may install a theme from a remote source using the --from option.
php artisan theme:install AuthorName.ThemeName [email protected]:authorname/themename-theme.git
Use the --want option to specify a target branch or version.
php artisan theme:install AuthorName.ThemeName [email protected]:authorname/themename-theme.git --want=dev-develop
Use the --oc option if your package name has the oc prefix.
php artisan theme:install AuthorName.ThemeName [email protected]:authorname/oc-themename-theme.git --oc
theme:check - performs a system wide check of themes to see if they should be flagged read-only and protected from changes. This command will spin over every theme and check if it has been installed with composer, if so, a theme lock file is added and a child theme is created.
php artisan theme:check
theme:list - list installed themes.
php artisan theme:list
theme:use - switch the active theme. The following example will switch to the theme in /themes/rainlab-vanilla
php artisan theme:use vanilla
theme:remove - delete a theme. The following example will delete the directory /themes/rainlab-vanilla
php artisan theme:remove vanilla
October CMS includes a number of utility commands.
cache:clear - clears the application, twig and combiner cache directories. Example:
php artisan cache:clear
october:fresh - removes the demo theme and plugin that ships with October CMS.
php artisan october:fresh
october:mirror - will mirror all asset and resource files to the public folder using symbolic linking.
php artisan october:mirror
If you want to specify a custom folder, you can pass it as the second argument, which is relative to the base directory.
php artisan october:mirror mypublicfolder
october:util - a generic command to perform general utility tasks, such as cleaning up files or combining files. The arguments passed to this command will determine the task used.
Outputs combined system files for JavaScript (js), StyleSheets (less), client side language (lang), or everything (assets).
php artisan october:util compile assets
php artisan october:util compile lang
php artisan october:util compile js
php artisan october:util compile less
To combine without minification, pass the --debug option.
php artisan october:util compile js --debug
This will execute the command git pull on all theme and plugin directories.
php artisan october:util git pull
Deletes all generated thumbnails in the uploads directory.
php artisan october:util purge thumbs
Deletes files in the uploads directory that do not exist in the system_files table.
php artisan october:util purge uploads
Deletes records in system_files table that do not belong to any other model.
php artisan october:util purge orphans