Skip to content

Console

QUIQQER installations provide a ./console entry point in the installation root. Operators use it for maintenance, updates, setup runs, cache cleanup, cron processing, backups, and diagnostics.

Run console commands from the QUIQQER installation root:

shell
./console --help

The help output lists the available system tools, package tools, and command groups for the current installation. The exact list depends on the installed packages.

Calling Commands

Console commands are called directly by their registered name. Core commands usually use the quiqqer: namespace:

shell
./console quiqqer:info
./console quiqqer:health
./console quiqqer:backup
./console quiqqer:maintenance --status=on

The older --tool=... form is no longer required.

Frequently used core commands also provide short aliases:

shell
./console setup
./console update
./console clear-cache

Package commands use the namespace registered by their package:

shell
./console package:cron

Use the help output of the installation to see which package commands are available.

Shell Completion

Shell completion is available starting with QUIQQER 2.31.

Install shell completion once for the current operating-system user:

shell
./console completion:install

The installer detects the current shell and supports Bash, Zsh, and Fish. No root permissions are required. To select a shell explicitly, pass its name:

shell
./console completion:install --shell=bash
./console completion:install --shell=zsh
./console completion:install --shell=fish

For Bash and Zsh, the installer creates a completion file in the user configuration directory and adds an idempotent source block to .bashrc or .zshrc. Fish uses its standard user-level autoload directory. Existing shell configuration is preserved.

Restart the shell after installation. Command completion is then available from every QUIQQER installation root:

shell
./console quiqqer:<Tab><Tab>
./console quiqqer:package --<Tab><Tab>

Completion is dynamic. It reads the commands and options provided by the current installation, including commands from installed packages and projects. Installing or removing a package therefore does not require regenerating a static command list.

Run completion:install again to update the installed shell integration after a related QUIQQER core update. The installation is safe to repeat.

Discovering Commands

Enter a command group to display its commands and descriptions:

shell
./console quiqqer:

An incomplete command prefix displays matching commands instead of executing anything:

shell
./console quiqqer:mai

For example, this prefix can suggest quiqqer:mailqueue and quiqqer:maintenance. If the prefix has no matches, the console reports that no command was found.

Useful Operator Commands

CommandPurpose
./console --helpShow console help and available tools.
./console --listtoolsList tools, including tools that require login.
./console quiqqer:infoPrint system information.
./console quiqqer:healthRun system health checks.
./console package --listList installed packages.
./console package --install=vendor/packageInstall a package through QUIQQER package management.
./console composer require vendor/packagePass require vendor/package to the Composer integrated in QUIQQER.
./console update --checkCheck for package updates.
./console updateRun system and package updates.
./console setupRun the setup workflow.
./console clear-cacheClear the QUIQQER cache.
./console clear-all-quiqqer-cacheClear cache, temporary data, sessions, locks, and QUIQQER cache data.
./console cronExecute cron processing.
./console quiqqer:backupCreate a system backup.
./console htaccessGenerate the Apache .htaccess file.
./console quiqqer:nginxGenerate the NGINX configuration file.
./console quiqqer:maintenance --status=onEnable maintenance mode.
./console quiqqer:maintenance --status=offDisable maintenance mode.

See Configuration for the configuration files and settings affected by operational changes.

See Package Management for package installation and direct Composer access.

Update Workflow

A typical production update uses this sequence:

shell
./console quiqqer:maintenance --status=on
./console update --check
./console update
./console setup
./console clear-cache
./console quiqqer:maintenance --status=off

Prepare backups before running the update. After the update, check the frontend, the administration interface, and logs.

Cron Processing

Cron processing can be executed through the console:

shell
./console cron

Packages can also provide their own cron-related commands. Use ./console --help on the target installation to see the installed cron tools.

Package Commands

Installed packages can register additional console commands. These commands are part of the installed system and can differ between projects.

Use package commands for package-specific maintenance tasks such as imports, queue processing, cache generation, or repair tasks. Check command help before running destructive or long-running operations.

Use Package Management when installing, removing, or inspecting installed packages.

Safety Rules

  • run commands from the installation root
  • use the same PHP version as the web runtime when possible
  • run production updates inside a maintenance window
  • create backups before updates, migrations, or destructive commands
  • check the command output and logs before running follow-up repair steps
  • do not run package-specific commands from another project without checking their help output

Released under GPL-3.0-or-later.