October CMS includes these commands for managing your project.
project:sync installs all plugins and themes belonging to a project.
php artisan project:syncproject: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.PluginNameUse the --want option to install a specific plugin version.
php artisan plugin:install AuthorName.PluginName --want=1.0You may install a plugin from a remote source using the --from option.
php artisan plugin:install AuthorName.PluginName --from=git@github.com:authorname/pluginname-plugin.gitUse the --want option to specify a target branch or version.
php artisan plugin:install AuthorName.PluginName --from=git@github.com:authorname/pluginname-plugin.git --want=dev-developUse the --oc option if your package name has the oc prefix.
php artisan plugin:install AuthorName.PluginName --from=git@github.com:authorname/pluginname-plugin.git --ocplugin: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:checkplugin:refresh - destroys the plugin's database tables and recreates them. This command is useful for development.
php artisan plugin:refresh AuthorName.PluginNameUse the --rollback option to only destroy the database tables without recreating them.
php artisan plugin:refresh AuthorName.PluginName --rollbackYou may also specify a version number with the --rollback option to stop at a specified version.
php artisan plugin:refresh AuthorName.PluginName --rollback=1.0.3plugin:list - Displays a list of installed plugins and their version numbers.
php artisan plugin:listplugin:disable - Disable an existing plugin.
php artisan plugin:disable AuthorName.PluginNameplugin:enable - Enable a disabled plugin.
php artisan plugin:enable AuthorName.PluginNameplugin:remove - destroys the plugin's database tables and deletes the plugin files from the filesystem.
php artisan plugin:remove AuthorName.PluginNameOctober 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.ThemeNameYou may install a theme from a remote source using the --from option.
php artisan theme:install AuthorName.ThemeName --from=git@github.com:authorname/themename-theme.gitUse the --want option to specify a target branch or version.
php artisan theme:install AuthorName.ThemeName --from=git@github.com:authorname/themename-theme.git --want=dev-developUse the --oc option if your package name has the oc prefix.
php artisan theme:install AuthorName.ThemeName --from=git@github.com:authorname/oc-themename-theme.git --octheme: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:checktheme:list - list installed themes.
php artisan theme:listtheme:use - switch the active theme. The following example will switch to the theme in /themes/rainlab-vanilla
php artisan theme:use rainlab-vanillatheme:remove - delete a theme. The following example will delete the directory /themes/rainlab-vanilla
php artisan theme:remove rainlab-vanillatheme:copy - duplicates an existing theme to create a new one, including the creation of child themes.
php artisan theme:copy <source-theme> [destination-theme]