odoocli command reference

Generated from odoocli docs export --json: 121 commands, 92 of which run against a remote server and 29 of which must run on the server itself.

Pass --server <name|url> to choose a stored connection or an API endpoint, or --local to act on the host you are on. Every command also accepts the global options listed in Configuration files, which are omitted from the tables below.

Connections

odoocli talks to a remote server by default. Connections are stored once and then named, so day-to-day commands do not repeat a URL and an API key.

odoocli connection add

Store a new management-API connection.

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`-n`, `--name`	No	Name of the connection.
`-u`, `--url`	No	Base URL of the management API (e.g. http://server:5210).
`-k`, `--api-key`	No	API key for the management API. Prompted for when omitted.
`--default`	No	Make this connection the default. The first stored connection is the default automatically.

Local only

# odoocli connection add

odoocli connection default

Show or set the default management-API connection.

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`-n`, `--name`	No	Name of the connection.

Local only

# odoocli connection default

odoocli connection list

List the stored management-API connections.

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`--show-secrets`	No	Reveal secrets (passwords, tokens) instead of masking them.

Local only

# odoocli connection list

odoocli connection remove

Remove a stored management-API connection.

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`-n`, `--name`	No	Name of the connection.

Local only

# odoocli connection remove

Server

Installing, configuring and maintaining the host itself: the managed containers, the endpoints the management API and Web UI listen on, the API key, mail, intrusion prevention and PostgreSQL.

odoocli server apikey - Manage the management API key shared by the API and Web containers.
odoocli server config - Manage the Odoo server configuration.
odoocli server cron - Manage the Odoo server scheduled tasks.
odoocli server database - Manage the Odoo server database.
odoocli server datastore - Manage the Odoo server datastore.
odoocli server fail2ban - Manage Fail2Ban for the Odoo server.
odoocli server fail2ban config - Manage the Odoo server Fail2Ban configuration.
odoocli server postgres - Manage PostgreSQL for the Odoo server.
odoocli server postgres image - Manage the PostgreSQL image.

odoocli server apikey rotate

Rotate the management API key and redeploy the API and Web containers (local repair command).

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`-y`, `--yes`	No	Assume 'yes' to all prompts and run non-interactively.

Local only

# odoocli server apikey rotate

odoocli server config create

Create the Odoo server configuration.

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`-p`, `--preset`	Yes	Odoo server configuration preset (Development or Production).

Local only

# odoocli server config create

odoocli server config edit

Edit the Odoo server configuration.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli server config edit

odoocli server config endpoints

Show or change the management API and Web ports and bind addresses (local command).

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`--api-port`	No	Port the management API listens on (default 5210).
`--api-bind`	No	Address the management API binds to: '*' (all addresses), an IP address, or 'localhost'.
`--web-port`	No	Port the management Web UI listens on (default 5220).
`--web-bind`	No	Address the management Web UI binds to: '*' (all addresses), an IP address, or 'localhost'.
`--web-https`	No	Serve the management Web UI over HTTPS with a self-signed certificate (on by default; required for passkeys, which browsers only allow in a secure context).

Local only

# odoocli server config endpoints

odoocli server config import

Import the Odoo server configuration.

Option	Required	Description
`-p`, `--preset`	Yes	Odoo server configuration preset (Development or Production).
`--keep-guid`	No	Keep the server GUID from the imported configuration instead of regenerating it.
`-j`, `--json`	Yes	Odoo server JSON configuration file path.
`-y`, `--yes`	No	Assume 'yes' to all prompts and run non-interactively.

Remote or local

# odoocli server config import

odoocli server config rebuild

rebuilds an Odoo server configuration.

Remote or local

# odoocli server config rebuild

odoocli server config update

Update the Odoo server configuration.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli server config update

odoocli server config validate-dns

Validate the Odoo instance DNS record(s).

Remote or local

# odoocli server config validate-dns

odoocli server cron create

Create the Odoo server scheduled tasks.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli server cron create

odoocli server cron remove

Remove the Odoo server scheduled tasks.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli server cron remove

odoocli server database list

List databases.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli server database list

odoocli server datastore migrate

Migrate the Odoo server datastore.

Remote or local

# odoocli server datastore migrate

odoocli server fail2ban ban

Manually ban an IP address on the Odoo server.

Argument	Required	Description
`<ip>`	Yes	The IPv4 or IPv6 address to ban.
`<jail>`	Yes	The fail2ban jail to ban the address in, for example 'odoo-login'.

Remote or local

# odoocli server fail2ban ban

odoocli server fail2ban config install

Install the Odoo server Fail2Ban filter and jail configuration.

Remote or local

# odoocli server fail2ban config install

odoocli server fail2ban config remove

Remove the Odoo server Fail2Ban filter and jail configuration.

Remote or local

# odoocli server fail2ban config remove

odoocli server fail2ban install

Install the Fail2Ban service.

Remote or local

# odoocli server fail2ban install

odoocli server fail2ban list

List the Odoo server ban(s).

Option	Required	Description
`-A`, `--all`	No	Lists every ban record, expired and active.

Remote or local

# odoocli server fail2ban list

odoocli server fail2ban remove

Remove the Fail2Ban service.

Remote or local

# odoocli server fail2ban remove

odoocli server fail2ban unban

Unban an IP address on the Odoo server.

Option	Required	Description
`-A`, `--all`	No	Lists every ban record, expired and active.

Remote or local

# odoocli server fail2ban unban

odoocli server info

Show the Odoo server information (URLs, ports, credentials).

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`--show-secrets`	No	Reveal secrets (passwords, tokens) instead of masking them.

Local only

# odoocli server info

odoocli server install

Install the Odoo server.

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.

Remote or local

# odoocli server install

odoocli server postgres image build

Build the PostgreSQL image.

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.

Remote or local

# odoocli server postgres image build

odoocli server postgres image list

List PostgreSQL images.

Remote or local

# odoocli server postgres image list

odoocli server postgres image remove

Remove unused PostgreSQL images.

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.

Remote or local

# odoocli server postgres image remove

odoocli server postgres reindex

Rebuild all indexes across all PostgreSQL databases (concurrently).

Option	Required	Description
`--jobs`	No	Number of parallel maintenance jobs (0 = auto).

Remote or local

# odoocli server postgres reindex

odoocli server postgres shell

Open a shell to the PostgreSQL server.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli server postgres shell

odoocli server postgres vacuum

Run VACUUM + ANALYZE across all PostgreSQL databases.

Option	Required	Description
`--jobs`	No	Number of parallel maintenance jobs (0 = auto).
`--full`	No	Run VACUUM FULL (rewrites tables; takes exclusive locks - use with care).

Remote or local

# odoocli server postgres vacuum

odoocli server update

Check for newer Docker images and host apt package updates for the Odoo server.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli server update

odoocli server upgrade

Upgrade the Odoo server: apply newer Docker images and host apt package updates.

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`-y`, `--yes`	No	Assume 'yes' to all prompts and run non-interactively.

Local only

# odoocli server upgrade

Instances

Creating and running Odoo instances: their configuration, containers, images, certificates, Git-backed addons, databases and backups.

odoocli instance backup-config - Manage the Odoo instance backup configuration.
odoocli instance certificate - Manage the Odoo instance certificate(s).
odoocli instance config - Manage the Odoo instance configuration.
odoocli instance config database - Manage the Odoo instance configuration in the database.
odoocli instance container - Manage the container(s) of the Odoo instance.
odoocli instance cron - Manage the Odoo instance scheduled tasks.
odoocli instance database - Manage the database(s) of the Odoo instance.
odoocli instance database comment - Get or set the Odoo instance database comment.
odoocli instance database sysadmin - Manage the Odoo instance database sysadmin(s).
odoocli instance database user - Manage the Odoo instance database user(s).
odoocli instance image - Manage the Odoo instance image(s).
odoocli instance modules - Manage the Odoo instance modules.
odoocli instance nginx - Manage Nginx for the Odoo instance.
odoocli instance nginx config - Manage the Odoo instance Nginx configuration.
odoocli instance odoo - Manage Odoo Community and Enterprise addon modules for the instance.
odoocli instance repair - Repair an Odoo instance.
odoocli instance restore-config - Manage the Odoo instance restore configuration.

odoocli instance backup

Backup an Odoo instance.

Option	Required	Description
`--backup-format`	No	Backup format.
`--backup-provider`	No	Backup provider(s).
`--backup-destination`	No	Backup destination.

Remote or local

# odoocli instance backup

odoocli instance backup-config set

Set the Odoo instance backup mode and storage providers.

Option	Required	Description
`--mode`	No	Mode: Disabled, Manual or Automatic. Omit to keep the current mode.
`--provider`	No	Provider type to add or update: Lfs, Ftp, S3 or AzureBlob.
`--name`	No	Name of the provider entry to add or update (required with --provider).
`--enable`	No	Enable the provider entry.
`--disable`	No	Disable the provider entry.
`--remote-path`	No	Remote path (Lfs, Ftp).
`--hostname`	No	FTP host name.
`--port`	No	FTP port.
`--username`	No	FTP user name.
`--password`	No	FTP password. Omit to be prompted (or to keep the stored one with --no-prompt); pass an empty string to clear it.
`--encryption`	No	FTP encryption mode: None, Implicit, Explicit or Auto.
`--bucket`	No	S3 bucket name.
`--access-key`	No	S3 access key id, or the Azure storage key/SAS token (the Azure value is a secret).
`--secret-key`	No	S3 secret key. Omit to be prompted (or to keep the stored one with --no-prompt); pass an empty string to clear it.
`--region`	No	S3 region.
`--service-url`	No	S3 endpoint for S3-compatible storage (e.g. MinIO), or the Azure service URI.
`--storage-account`	No	Azure storage account name.
`--container`	No	Azure blob container.
`--prefix`	No	Object prefix (S3, AzureBlob).
`--no-prompt`	No	Never prompt for a secret; leave the stored one unchanged.

Remote or local

# odoocli instance backup-config set

odoocli instance backup-config show

Show the Odoo instance backup configuration.

Remote or local

# odoocli instance backup-config show

odoocli instance certificate list

List the Odoo instance certificates.

Remote or local

# odoocli instance certificate list

odoocli instance certificate renew

Renew the Odoo instance certificate when it is missing, invalid, or nearing expiry.

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.

Remote or local

# odoocli instance certificate renew

odoocli instance certificate request

Request the Odoo instance certificate.

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.

Remote or local

# odoocli instance certificate request

odoocli instance config apply

Apply pending configuration changes to the running Odoo instance(s).

Option	Required	Description
`--force`	No	Apply the full plan (config rewrite, nginx rebuild, restart) even when no changes are pending.
`--record-only`	No	Record the stored configuration as applied without touching the running system (baseline for instances that predate change tracking).

Remote or local

# odoocli instance config apply

odoocli instance config create

Create an Odoo instance configuration.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli instance config create

odoocli instance config database export

Export the Odoo instance configuration(s) from the database to JSON files.

Option	Required	Description
`-e`, `--export-path`	No	Directory path to export to. Defaults to the Odoo instance configuration directory.
`-y`, `--yes`	No	Assume 'yes' to all prompts and run non-interactively.

Remote or local

# odoocli instance config database export

odoocli instance config database import

Import the Odoo instance configuration(s) from the JSON configuration files into the application database.

Remote or local

# odoocli instance config database import

odoocli instance config edit

Edit the Odoo instance configuration.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli instance config edit

odoocli instance config export

Export the Odoo instance(s) configuration.

Option	Required	Description
`-e`, `--export-path`	Yes	Directory path to export to.
`--skip-existing-files`	No	Skip existing files.

Remote or local

# odoocli instance config export

odoocli instance config import

Import an Odoo instance from a configuration file.

Option	Required	Description
`-j`, `--json`	Yes	Odoo instance JSON configuration file path.
`-p`, `--preset`	Yes	Odoo instance environment preset (dev, test, staging, dr, prod).
`--keep-guid`	No	Keep the instance GUID from the imported configuration instead of regenerating it.

Remote or local

# odoocli instance config import

odoocli instance config preset

Manage the Odoo instance configuration presets.

Option	Required	Description
`-p`, `--preset`	Yes	Odoo instance environment preset (dev, test, staging, dr, prod).
`-y`, `--yes`	No	Assume 'yes' to all prompts and run non-interactively.

Remote or local

# odoocli instance config preset

odoocli instance config rebuild

rebuilds an Odoo instance configuration.

Remote or local

# odoocli instance config rebuild

odoocli instance config source

Show or set the primary source for the Odoo instance configurations (Json or Database).

Argument	Required	Description
`<source>`	No	The primary source to switch to (Json or Database). Omit to show the current value.

Remote or local

# odoocli instance config source

odoocli instance config status

Show pending (unapplied) configuration changes of the Odoo instance(s).

Remote or local

# odoocli instance config status

odoocli instance config update

updates an Odoo instance configuration.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli instance config update

odoocli instance config validate-dns

Validate the Odoo instance DNS record(s).

Remote or local

# odoocli instance config validate-dns

odoocli instance container restart

Restart the Odoo container.

Remote or local

# odoocli instance container restart

odoocli instance container shell

Open an interactive shell session inside the Odoo container.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli instance container shell

odoocli instance container start

Start the Odoo container.

Remote or local

# odoocli instance container start

odoocli instance container stop

Stop the Odoo container.

Remote or local

# odoocli instance container stop

odoocli instance cron backup

Scheduled backup of Odoo instances based on the instance manifest.

Remote or local

# odoocli instance cron backup

odoocli instance cron certificate

Scheduled renewal of Odoo instance SSL certificates (Let's Encrypt and self-signed).

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.

Remote or local

# odoocli instance cron certificate

odoocli instance cron restore

Scheduled restore of Odoo instances based on the instance manifest.

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.

Remote or local

# odoocli instance cron restore

odoocli instance database activate

Activate an Odoo instance database.

Remote or local

# odoocli instance database activate

odoocli instance database backup

Backup an Odoo instance database.

Option	Required	Description
`--backup-format`	No	Database backup format.
`--backup-destination`	No	Backup destination.
`-o`, `--overwrite`	No	Overwrite the destination if it already exists.

Remote or local

# odoocli instance database backup

odoocli instance database cloc

Count the lines of code for the installed Odoo instance database addons.

Remote or local

# odoocli instance database cloc

odoocli instance database clone

Clone an Odoo instance database.

Option	Required	Description
`-n`, `--name`	No	Odoo database name.
`-p`, `--preset`	Yes	Odoo instance environment preset (dev, test, staging, dr, prod).
`--neutralize`	No	Neutralize the Odoo instance database.
`--activate`	No	Activate the Odoo instance database.

Remote or local

# odoocli instance database clone

odoocli instance database comment get

Get the Odoo instance database comment.

Remote or local

# odoocli instance database comment get

odoocli instance database comment set

Set the Odoo instance database comment.

Option	Required	Description
`--schema-version`	No	Schema version for the database comment.
`--customer`	No	Customer or tenant identifier.
`--restored-from-instance`	No	Source Odoo instance identifier.
`--restored-from-name`	No	Source database name at the origin instance.
`--restored-datetime-utc`	No	Restore UTC timestamp (ISO-8601).
`--active`	No	Mark the database as active.
`--clear`	No	Clear the database comment instead of setting it.

Remote or local

# odoocli instance database comment set

odoocli instance database create

Create an Odoo instance database.

Option	Required	Description
`-n`, `--name`	No	Odoo database name.
`--no-init`	No	Do not initialize the Odoo database.
`-c`, `--country`	Yes	Two-letter ISO country code used to initialize the Odoo database (e.g. BE, NL, FR).
`--location`	No	Odoo instance database filestore location.
`--activate`	No	Activate the Odoo instance database.
`-p`, `--preset`	Yes	Odoo instance environment preset (dev, test, staging, dr, prod).

Remote or local

# odoocli instance database create

odoocli instance database dump

Dump an Odoo instance database to a file using the custom format.

Option	Required	Description
`--backup-destination`	Yes	Backup destination.
`-o`, `--overwrite`	No	Overwrite the destination if it already exists.

Remote or local

# odoocli instance database dump

odoocli instance database init

Initialize an Odoo instance database.

Option	Required	Description
`-c`, `--country`	Yes	Two-letter ISO country code used to initialize the Odoo database (e.g. BE, NL, FR).
`--activate`	No	Activate the Odoo instance database.

Remote or local

# odoocli instance database init

odoocli instance database list

List the Odoo instance database(s).

Remote or local

# odoocli instance database list

odoocli instance database load

Load an Odoo instance database from a custom dump format.

Option	Required	Description
`-a`, `--archive`	Yes	Archive to restore the database from (e.g. /backups/odoo-2025-10-28.zip).
`-p`, `--preset`	Yes	Odoo instance environment preset (dev, test, staging, dr, prod).

Remote or local

# odoocli instance database load

odoocli instance database migrate-filestore

Migrate an Odoo instance database filestore.

Option	Required	Description
`-y`, `--yes`	No	Assume 'yes' to all prompts and run non-interactively.
`--location`	Yes	Odoo instance database filestore location.
`-b`, `--batch-size`	No	Number of records processed in each migration batch.

Remote or local

# odoocli instance database migrate-filestore

odoocli instance database modules

Manage the Odoo instance database modules.

Argument	Required	Description
`<ModuleAction>`	Yes	Odoo instance database module action.

Option	Required	Description
`-m`, `--modules`	No	Odoo instance database modules (comma- or semicolon-separated).

Remote or local

# odoocli instance database modules

odoocli instance database options

Process the Odoo instance database restore options.

Option	Required	Description
`-p`, `--preset`	Yes	Odoo instance environment preset (dev, test, staging, dr, prod).

Remote or local

# odoocli instance database options

odoocli instance database postgres

Launch the Odoo instance database PostgreSQL shell.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli instance database postgres

odoocli instance database recaptcha

Enable or disable the Odoo instance database reCAPTCHA.

Option	Required	Description
`--enable`	Yes	Enable or disable.

Remote or local

# odoocli instance database recaptcha

odoocli instance database reindex

Rebuild all indexes on a specific Odoo instance database (concurrently).

Option	Required	Description
`--jobs`	No	Number of parallel maintenance jobs (0 = auto).

Remote or local

# odoocli instance database reindex

odoocli instance database remove

Remove an Odoo instance database.

Remote or local

# odoocli instance database remove

odoocli instance database rename

Rename an Odoo instance database.

Option	Required	Description
`-n`, `--name`	No	Odoo database name.

Remote or local

# odoocli instance database rename

odoocli instance database reset-permissions

Repair the Odoo instance database permissions.

Remote or local

# odoocli instance database reset-permissions

odoocli instance database restore

Restore an Odoo instance database.

Option	Required	Description
`-a`, `--archive`	Yes	Archive to restore the database from (e.g. /backups/odoo-2025-10-28.zip).
`-n`, `--name`	No	Odoo database name, or leave empty to use the name from the archive.
`-p`, `--preset`	Yes	Odoo instance environment preset (dev, test, staging, dr, prod).
`-o`, `--overwrite`	No	Overwrite the destination if it already exists.
`--restore-filestore`	No	Restore the Odoo filestore from the archive.
`--keep-guid`	No	Keep the Odoo database UUID from the backup instead of regenerating it.

Remote or local

# odoocli instance database restore

odoocli instance database shell

Launch the Odoo instance database shell.

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`--limit-request`	No	Number of requests a worker will process before being recycled and restarted.
`--limit-memory-soft`	No	Maximum allowed virtual memory per worker in bytes. If the limit is exceeded, the worker is killed and recycled at the end of the current request.
`--limit-memory-hard`	No	Hard limit on virtual memory in bytes. Any worker exceeding the limit will be immediately killed without waiting for the end of the current request processing.
`--limit-time-cpu`	No	Number of CPU seconds the worker is allowed to use for each request.
`--limit-time-real`	No	Number of seconds the worker can process a request.

Local only

# odoocli instance database shell

odoocli instance database size

Show the size of an Odoo instance database (PostgreSQL + filestore).

Remote or local

# odoocli instance database size

odoocli instance database sysadmin create

Create an Odoo instance database sysadmin.

Remote or local

# odoocli instance database sysadmin create

odoocli instance database sysadmin remove

Remove an Odoo instance database sysadmin.

Remote or local

# odoocli instance database sysadmin remove

odoocli instance database user list

List Odoo instance database users.

Remote or local

# odoocli instance database user list

odoocli instance database user password-reset

Reset an Odoo instance database user password.

Remote or local

# odoocli instance database user password-reset

odoocli instance database user totp-disable

Disable an Odoo instance database user's TOTP (multi-factor authentication).

Remote or local

# odoocli instance database user totp-disable

odoocli instance database user totp-reset

Reset an Odoo instance database user's TOTP (multi-factor authentication).

Remote or local

# odoocli instance database user totp-reset

odoocli instance database user totp-token

Generate the current TOTP token for an Odoo instance database user.

Remote or local

# odoocli instance database user totp-token

odoocli instance database vacuum

Run VACUUM + ANALYZE on a specific Odoo instance database.

Option	Required	Description
`--jobs`	No	Number of parallel maintenance jobs (0 = auto).
`--full`	No	Run VACUUM FULL (rewrites tables; takes exclusive locks - use with care).

Remote or local

# odoocli instance database vacuum

odoocli instance image activate

Activate an Odoo instance image.

Option	Required	Description
`-t`, `--image-tag`	No	Odoo Docker image tag to use.

Remote or local

# odoocli instance image activate

odoocli instance image build

Build an Odoo instance image.

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.
`-t`, `--image-tag`	No	Odoo Docker image tag to use.

Remote or local

# odoocli instance image build

odoocli instance image list

List Odoo instance images.

Option	Required	Description
`-l`, `--limit`	No	Maximum number of results to return.

Remote or local

# odoocli instance image list

odoocli instance image remove

Remove an Odoo instance image.

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.

Remote or local

# odoocli instance image remove

odoocli instance import

Import the Odoo instance from a backup archive.

Option	Required	Description
`-a`, `--archive`	No	Odoo instance backup archive.
`-p`, `--preset`	Yes	Odoo instance environment preset (dev, test, staging, dr, prod).
`--fqdn`	No	One or more Fully Qualified Domain Names (FQDNs) for the Odoo instance. The first FQDN serves as the primary or master domain for the Odoo instance.
`-g`, `--github-token`	No	GitHub access token.
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.

Remote or local

# odoocli instance import

odoocli instance info

Show the Odoo instance information (URLs, paths, credentials).

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`--show-secrets`	No	Reveal secrets (passwords, tokens) instead of masking them.

Local only

# odoocli instance info

odoocli instance install

Install an Odoo instance.

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.
`-t`, `--image-tag`	No	Odoo Docker image tag to use.

Remote or local

# odoocli instance install

odoocli instance list

List configured Odoo instance(s).

Remote or local

# odoocli instance list

odoocli instance modules install

Install selected Odoo instance modules.

Option	Required	Description
`-m`, `--modules`	No	Odoo instance modules (comma- or semicolon-separated).
`--latest`	No	Update to the latest module versions.

Remote or local

# odoocli instance modules install

odoocli instance modules select

Select available Odoo instance modules for installation.

Remote or local

# odoocli instance modules select

odoocli instance nginx config rebuild

Rebuild an Odoo instance Nginx configuration and reload Nginx.

Remote or local

# odoocli instance nginx config rebuild

odoocli instance nginx install

Install the Odoo instance Nginx configuration.

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.

Remote or local

# odoocli instance nginx install

odoocli instance odoo install

Install or update Odoo Community and Enterprise addon modules for the instance.

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.
`--latest`	No	Update to the latest module versions.

Remote or local

# odoocli instance odoo install

odoocli instance remove

Remove an Odoo instance.

Option	Required	Description
`--delete-config`	No	Also delete the instance configuration file and its backups. By default they are preserved.

Remote or local

# odoocli instance remove

odoocli instance repair filesystem

Repair Odoo instance filesystem permissions.

Remote or local

# odoocli instance repair filesystem

odoocli instance restore

Restore the Odoo instance from a backup archive.

Option	Required	Description
`-f`, `--force`	No	Force the command to execute, ignoring errors or conflicts.
`-a`, `--archive`	No	Odoo instance backup archive.

Remote or local

# odoocli instance restore

odoocli instance restore-config set

Set the Odoo instance restore mode and storage providers.

Option	Required	Description
`--mode`	No	Mode: Disabled, Manual or Automatic. Omit to keep the current mode.
`--provider`	No	Provider type to add or update: Lfs, Ftp, S3 or AzureBlob.
`--name`	No	Name of the provider entry to add or update (required with --provider).
`--enable`	No	Enable the provider entry.
`--disable`	No	Disable the provider entry.
`--remote-path`	No	Remote path (Lfs, Ftp).
`--hostname`	No	FTP host name.
`--port`	No	FTP port.
`--username`	No	FTP user name.
`--password`	No	FTP password. Omit to be prompted (or to keep the stored one with --no-prompt); pass an empty string to clear it.
`--encryption`	No	FTP encryption mode: None, Implicit, Explicit or Auto.
`--bucket`	No	S3 bucket name.
`--access-key`	No	S3 access key id, or the Azure storage key/SAS token (the Azure value is a secret).
`--secret-key`	No	S3 secret key. Omit to be prompted (or to keep the stored one with --no-prompt); pass an empty string to clear it.
`--region`	No	S3 region.
`--service-url`	No	S3 endpoint for S3-compatible storage (e.g. MinIO), or the Azure service URI.
`--storage-account`	No	Azure storage account name.
`--container`	No	Azure blob container.
`--prefix`	No	Object prefix (S3, AzureBlob).
`--no-prompt`	No	Never prompt for a secret; leave the stored one unchanged.

Remote or local

# odoocli instance restore-config set

odoocli instance restore-config show

Show the Odoo instance restore configuration.

Remote or local

# odoocli instance restore-config show

odoocli instance size

Show the aggregate size of an Odoo instance (databases + directory tree).

Remote or local

# odoocli instance size

Users

Break-glass repair of the management console accounts, from the host.

odoocli user list

List the management-UI user accounts.

Remote or local

# odoocli user list

odoocli user password-reset

Reset an account password to a generated one (break-glass).

Argument	Required	Description
`<username>`	Yes	The login name of the account.

Remote or local

# odoocli user password-reset

odoocli user totp-disable

Disable MFA for an account (break-glass).

Argument	Required	Description
`<username>`	Yes	The login name of the account.

Remote or local

# odoocli user totp-disable

odoocli user unlock

Clear the lockout and re-enable an account (break-glass).

Argument	Required	Description
`<username>`	Yes	The login name of the account.

Remote or local

# odoocli user unlock

Licence

The licence agreement.

odoocli license agreement - Manage the license agreement.

odoocli license agreement show

Show license agreement.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli license agreement show

System

The master database provider and host housekeeping.

odoocli system database - Manage the application ("master") database.

odoocli system assemblies

list loaded assemblies and their versions.

Local only

This command has no remote form. Run it on the server itself.

Local only

# odoocli system assemblies

odoocli system commands

List all available commands and their descriptions.

Local only

This command has no remote form. Run it on the server itself.

Argument	Required	Description
`<filter>`	No	Optional filter: only commands whose full name contains this value are listed.

Local only

# odoocli system commands

odoocli system database migrate

Migrate the application database between providers (drops and re-imports the destination).

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`--from`	No	Source database provider. Defaults to the active provider.
`--to`	No	Destination database provider. Defaults to PostgreSQL from a SQLite source and to SQLite from a PostgreSQL one; a SqlServer source needs it explicitly.
`-y`, `--yes`	No	Assume 'yes' to all prompts and run non-interactively.

Local only

# odoocli system database migrate

odoocli system database provider

Show or set the database provider for the application database (SQLite, PostgreSQL or SqlServer).

Local only

This command has no remote form. Run it on the server itself.

Argument	Required	Description
`<provider>`	No	The database provider to switch to (SQLite, PostgreSQL or SqlServer). Omit to show the current value.

Local only

# odoocli system database provider

odoocli system database reset

Reset (clean) the application database: drop and recreate it with an empty, current schema.

Local only

This command has no remote form. Run it on the server itself.

Option	Required	Description
`--provider`	No	Database provider to reset (SQLite, PostgreSQL or SqlServer). Defaults to the active provider.
`-y`, `--yes`	No	Assume 'yes' to all prompts and run non-interactively.

Local only

# odoocli system database reset

odoocli system maintenance

Vacuum the systemd journal, remove stale temporary files and expire old log files.

Option	Required	Description
`--journal-days`	No	Systemd journal retention window in days (0 = skip).
`--temp-age-days`	No	Maximum age in days of temporary files to remove from /tmp and /var/tmp (0 = skip).
`--log-age-days`	No	Maximum age in days of timestamped Odoo log files to remove (0 = skip).

Remote or local

# odoocli system maintenance

Release notes

What changed in this build.

odoocli release-notes

Show the release notes for this build.

Option	Required	Description
`--all`	No	Show every version in the changelog instead of only the running one.
`--release`	No	Show the notes for one specific version, for example '0.9.1'.

Remote or local

# odoocli release-notes

Connections​

odoocli connection add​

odoocli connection default​

odoocli connection list​

odoocli connection remove​

Server​

odoocli server apikey rotate​

odoocli server config create​

odoocli server config edit​

odoocli server config endpoints​

odoocli server config import​

odoocli server config rebuild​

odoocli server config update​

odoocli server config validate-dns​

odoocli server cron create​

odoocli server cron remove​

odoocli server database list​

odoocli server datastore migrate​

odoocli server fail2ban ban​

odoocli server fail2ban config install​

odoocli server fail2ban config remove​

odoocli server fail2ban install​

odoocli server fail2ban list​

odoocli server fail2ban remove​

odoocli server fail2ban unban​

odoocli server info​

odoocli server install​

odoocli server postgres image build​

odoocli server postgres image list​

odoocli server postgres image remove​

odoocli server postgres reindex​

odoocli server postgres shell​

odoocli server postgres vacuum​

odoocli server update​

odoocli server upgrade​

Instances​

odoocli instance backup​

odoocli instance backup-config set​

odoocli instance backup-config show​

odoocli instance certificate list​

odoocli instance certificate renew​

odoocli instance certificate request​

odoocli instance config apply​

odoocli instance config create​

odoocli instance config database export​

odoocli instance config database import​

odoocli instance config edit​

odoocli instance config export​

odoocli instance config import​

odoocli instance config preset​

odoocli instance config rebuild​

odoocli instance config source​

odoocli instance config status​

odoocli instance config update​

odoocli instance config validate-dns​

odoocli instance container restart​

odoocli instance container shell​

odoocli instance container start​

odoocli instance container stop​

odoocli instance cron backup​

odoocli instance cron certificate​

odoocli instance cron restore​

odoocli instance database activate​

odoocli instance database backup​

odoocli instance database cloc​

odoocli instance database clone​

odoocli instance database comment get​

odoocli instance database comment set​

odoocli instance database create​

odoocli instance database dump​

odoocli instance database init​

odoocli instance database list​

odoocli instance database load​

odoocli instance database migrate-filestore​

odoocli instance database modules​

odoocli instance database options​

odoocli instance database postgres​

odoocli instance database recaptcha​

odoocli instance database reindex​

odoocli instance database remove​

Connections

odoocli connection add

odoocli connection default

odoocli connection list

odoocli connection remove

Server

odoocli server apikey rotate

odoocli server config create

odoocli server config edit

odoocli server config endpoints

odoocli server config import

odoocli server config rebuild

odoocli server config update

odoocli server config validate-dns

odoocli server cron create

odoocli server cron remove

odoocli server database list

odoocli server datastore migrate

odoocli server fail2ban ban

odoocli server fail2ban config install

odoocli server fail2ban config remove

odoocli server fail2ban install

odoocli server fail2ban list

odoocli server fail2ban remove

odoocli server fail2ban unban

odoocli server info

odoocli server install

odoocli server postgres image build

odoocli server postgres image list

odoocli server postgres image remove

odoocli server postgres reindex

odoocli server postgres shell

odoocli server postgres vacuum

odoocli server update

odoocli server upgrade

Instances

odoocli instance backup

odoocli instance backup-config set

odoocli instance backup-config show

odoocli instance certificate list

odoocli instance certificate renew

odoocli instance certificate request

odoocli instance config apply

odoocli instance config create

odoocli instance config database export

odoocli instance config database import

odoocli instance config edit

odoocli instance config export

odoocli instance config import

odoocli instance config preset

odoocli instance config rebuild

odoocli instance config source

odoocli instance config status

odoocli instance config update

odoocli instance config validate-dns

odoocli instance container restart

odoocli instance container shell

odoocli instance container start

odoocli instance container stop

odoocli instance cron backup

odoocli instance cron certificate

odoocli instance cron restore

odoocli instance database activate

odoocli instance database backup

odoocli instance database cloc

odoocli instance database clone

odoocli instance database comment get

odoocli instance database comment set

odoocli instance database create

odoocli instance database dump

odoocli instance database init

odoocli instance database list

odoocli instance database load

odoocli instance database migrate-filestore

odoocli instance database modules

odoocli instance database options

odoocli instance database postgres

odoocli instance database recaptcha

odoocli instance database reindex

odoocli instance database remove