Skip to main content
page last edited on 17 January 2023

Console Utilities

Version: 5.5

Introduction

To solve certain tasks, XCart uses console utilities and shell scripts.

  • ./bin/console - Operations related primarily to X-Cart's business logic, as well as some maintenance actions that need to be performed from the X-Cart code.
  • ./bin/service - Maintenance operations. For example, module activation/deactivation.
  • ./bin/install.sh - Installation.
  • ./bin/upgrade.sh - Upgrade from the console.

./bin/console

To view all the available commands as a list, use the list command.

./bin/console list

This will allow you to see both the built-in Symfony commands as well as the commands of X-Cart. To view the list of only X-Cart commands, use the argument xcart.

./bin/console list xcart

For each command, there is help available which can be accessed by using the --help key. For example:

./bin/console xcart:assets:install --help

List of available commands

The command help (--help) provides more detailed information.

xcart:assets:install - Installs resources (js, css, images) from the X-Cart core and modules.

xcart:cron - Launches the execution of scheduled tasks (cron).

xcart:static-configuration:dump - Outputs static configuration values.

xcart:service:call-module-hook - Executes lifetime hooks of the modules or the core.

xcart:service:load-fixtures - Loads the data of the modules or the core.

xcart:service:load-labels - Loads the translation labels. Is used when updating the core or modules.

xcart:service:post-fixtures-load - Performs additional actions after data loading.

xcart:service:refresh-view-lists - Refreshes ViewLists.

xcart:service:resize-images - Creates thumbnails of images of business logic objects (products, categories, etc) by resizing them to the required dimensions for use in the front end.

./bin/service

To view all the available commands as a list, use the list command.

./bin/service list

This will allow you to see both the built-in Symfony commands as well as the commands of X-Cart. To view the list of only X-Cart commands, use the argument xcst.

./bin/service list xcst

For each command, there is help available which can be accessed by using the --help key. For example:

./bin/service xcart:assets:install --help

List of available commands

The command help (--help) provides more detailed information.

xcst:call-hook - Executes the lifetime hook of the service utility.

xcst:check-for-upgrade - Checks whether an update is available for the core or the modules.

xcst:integrity-check - Checks whether the files have been modified/tampered with.

xcst:license-list - Outputs a list of registered licenses.

xcst:pack-module - Created a module archive.

xcst:rebuild - Regenerates the code and the cache. Also it is possible to activate/deactivate or install/remove modules.

xcst:register-license - Registers a license key.

xcst:remove-active-scenario - Removes information about the current active scenario.

xcst:remove-license - Removes information about a license key.

xcst:verify-config - Outputs a breakdown of the build specification.

xcst:version-info - Outputs information about the current build.

./bin/install.sh

Is used for installation from the distribution pack. For specification, the file var/install.yaml is used. Note that it is possible to specify the admin login/password and the license key.

To get help on this command, use the key -h

The options -b -l -d -p are ignored if the file var/install.yaml is present.

./bin/upgrade.sh

Is used to update the core and/or the modules. For updating the core, the module ID CDev-Core should be used. It is also possible to update a module by using a module archive or by manually unpacking and replacing the updated files.

To get help on this command, use the key -h