Skip to content

Console Commands


You can php command.php instead of bin/command. May be reasonable if there's no execute permission for bin/command.

List of available commands


Clear cache

php clear_cache.php


php rebuild.php

Clears cache, rebuilds database.

Hard rebuild

As of v7.4.

bin/command rebuild --hard

Hard database rebuild. It will drop unused columns, decrease exceeding column lengths, fix index names, set proper collations. It won't drop unused tables (consider removing them manually).

Recommended to have a database backup before running hard rebuild.

Changing user password

bin/command set-password [username]

where [username] is a user name, e.g. admin.


bin/command upgrade

Upgrades EspoCRM instance to the next available version. The upgrade package is downloaded automatically. It may take a few steps to upgrade to the latest version, so you will need to run the same command a few times.

See additional parameters here.


Installing or upgrading:

bin/command extension --file="path/to/extension/"


bin/command extension -u --name="Extension Name"

Uninstalling by ID:

bin/command extension -u --id="extension-ID"

List all extensions:

bin/command extension -l

Running job

bin/command run-job JobName

where JobName is an internal name of the job you want to run.


bin/command run-job Cleanup
bin/command run-job ProcessMassEmail


Print the current version:

bin/command version

Setting user password

bin/command set-password {username}

where {username} is a user name, e.g. admin.

Creating admin user

As of v7.4.

bin/command create-admin-user {username}

where {username} is a user name, e.g. admin.

Can be useful when you need to run an Espo instance from a repository without the need to go through UI installation.


See here.

App info

bin/command app-info

With this command you can get some information about the application (container services, binding, jobs).

Update app timestamp

As of v8.1.

bin/command update-app-timestamp

Updates the app timestamp to the current time. When an Espo instance is updated or an extension is installed or uninstalled, the app timestamp is updated to let the browser know that the old cache is not actual anymore. Sometimes developers may need to update the app timestamp manually, e.g. when writing custom JS.

Rebuild category paths

bin/command rebuild-category-paths {EntityType}

Rebuilds category paths. E.g. for DocumentFolder, WorkflowCategory. May be needed if for some reason paths data is corrupted resulting in not working expanded mode.