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

QUIQQER supports short system tools and named package tools.

Common system tools can be called directly:

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

Use --tool for tools that do not have a short system alias:

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

Package tools are usually called by their command name:

shell
./console package:cron

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

Useful Operator Commands

CommandPurpose
./console --helpShow console help and available tools.
./console --listtoolsList tools, including tools that require login.
./console --tool=quiqqer:infoPrint system information.
./console --tool=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 --tool=quiqqer:backupCreate a system backup.
./console htaccessGenerate the Apache .htaccess file.
./console --tool=quiqqer:nginxGenerate the NGINX configuration file.
./console --tool=quiqqer:maintenance --status=onEnable maintenance mode.
./console --tool=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 --tool=quiqqer:maintenance --status=on
./console update --check
./console update
./console setup
./console clear-cache
./console --tool=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.