Console Basics
Terminal
Execute commands from the terminal:
php console.php [command] [options] --no-interaction --halt-on-error
Browser
Open domain.com/console.php
to execute commands from the browser.
Console Commands
Auth
auth Auth command login Login into the system --user Required user --password Required password logout Logout by the system
Backup
backup Backup command database Backup the database --directory Required directory
Cache
cache Cache command clear Clear the cache --directory Required directory of the cache --extension Required extension of the cache files --bundle Optional key or collection of the bundle clear-invalid Clear the invalid cache --directory Required directory of the cache --extension Required extension of the cache files --lifetime Optional lifetime of the bundle
Config
config Config command list List the configuration set Set the configuration --db-type Required database type --db-host Required database host or file --db-name Optional database name --db-user Optional database user --db-password Optional database password --db-prefix Optional database prefix reset Reset the configuration parse Parse the configuration --db-url Required database url
Help
help Help command <command> Show help for the <command>
Install
install Install command database Install the database --admin-name Required admin name --admin-user Required admin user --admin-password Required admin password --admin-email Required admin email module Install the module --alias Required module alias
Migrate
migrate Migrate command database Migrate the database
Restore
restore Restore command database Restore the database --directory Required directory --file Required file
Setting
setting Setting command list List the settings set Set the setting --key Required setting key --value Required setting value
Status
status Status command auth Show auth status database Show database status system Show system requirements
Uninstall
uninstall Uninstall command database Uninstall the database module Uninstall the module --alias Required module aliasEdit on GitHub