Command-line interface (CLI)¶
The CLI command-line interface offers several functionalities related to Odoo. You can use it to run the server, launch Odoo as a Python console environment, scaffold an Odoo module, populate a database, or count the number of lines of code.
The command to use to call the CLI depends on how you installed Odoo. In the examples below, we
assume that you are running Odoo from source with
odoo-bin file. If you installed Odoo from a distribution package or with Docker, you
must adapt the command.
Navigate to the root of the directory where you downloaded the source files of Odoo Community.
Run all CLI commands with ./odoo-bin
When Odoo was installed, an executable named
odoo was added to your user’s PATH. Replace
all occurrences of odoo-bin with odoo in the examples below.
Please refer to the documentation of the official Docker image of Odoo.
Help & version¶
- -h, --help¶
shows help text with all available options
shows Odoo version e.g. “Odoo Server 17.0”
You can enable auto-completion in your shell by running
echo "complete -W '`./odoo-bin --help | \ sed -e 's/[^a-z_-]\(-\+[a-z0-9_-]\+\)/\n\1\n/' | \ grep -- '^-' | sort | uniq | tr '\n' ' '`' odoo-bin" >> ~/.bash_completion
Running the server¶
- -d <database>, --database <database>¶
database(s) used when installing or updating modules. Providing a comma-separated list restrict access to databases provided in list.
For advanced database options, take a look below.
- -i <modules>, --init <modules>¶
comma-separated list of modules to install before running the server (requires
- -u <modules>, --update <modules>¶
comma-separated list of modules to update before running the server. Use
allfor all modules. (requires
- --addons-path <directories>¶
comma-separated list of directories in which modules are stored. These directories are scanned for modules.
- --upgrade-path <upgrade_path>¶
specify an additional upgrade path.
- --load <modules>¶
list of server-wide modules to load. Those modules are supposed to provide features not necessarily tied to a particular database. This is in contrast to modules that are always bound to a specific database when they are installed (i.e. the majority of Odoo addons). Default is
- -c <config>, --config <config>¶
- -D <data-dir-path>, --data-dir <data-dir-path>¶
directory path where to store Odoo data (eg. filestore, sessions). If not specified, Odoo will fallback to a predefined path. On Unix systems its one defined in
$XDG_DATA_HOMEenvironmental variable or
- -s, --save¶
saves the server configuration to the current configuration file (
$HOME/.odoorcby default, and can be overridden using
path to a file where the server pid will be stored
stops the server after its initialization.
- --geoip-city-db <path>¶
Absolute path to the GeoIP City database file.
- --geoip-country-db <path>¶
Absolute path to the GeoIP Country database file.
runs tests after module installation
- --test-file <file>¶
runs a python test file
Comma-separated list of specs to filter which tests to execute. Enable unit tests if set.
-specifies if we want to include or exclude tests matching this spec.
The tag will match tags added on a class with a
tagged()decorator (all test classes have
at_installtags until explicitly removed, see the decorator documentation).
*will match all tags.
If tag is omitted on include mode, its value is
If tag is omitted on exclude mode, its value is
The module, class, and method will respectively match the module name, test class name and test method name.
Filtering and executing the tests happens twice: right after each module installation/update and at the end of the modules loading. At each stage tests are filtered by
--test-tagsspecs and additionally by dynamic specs
Specify directory where to write screenshots when an HttpCase.browser_js test fails. It defaults to
Enable screencasts and specify directory where to write screencasts files. The
ffmpegutility needs to be installed to encode frames into a video file. Otherwise frames will be kept instead of the video file.
- -r <user>, --db_user <user>¶
database username, used to connect to PostgreSQL.
- --db_host <hostname>¶
host for the database server
UNIX socket otherwise
- --db_port <port>¶
port the database listens on, defaults to 5432
- --db-filter <filter>¶
hides databases that do not match
<filter>. The filter is a regular expression, with the additions that:
%his replaced by the whole hostname the request is made on.
%dis replaced by the subdomain the request is made on, with the exception of
www.odoo.comboth match the database
These operations are case sensitive. Add option
(?i)to match all databases (so domain
(?i)%dmatches the database
Since version 11, it’s also possible to restrict access to a given database listen by using the –database parameter and specifying a comma-separated list of databases
When combining the two parameters, db-filter supersedes the comma-separated database list for restricting database list, while the comma-separated list is used for performing requested operations like upgrade of modules.
$ odoo-bin --db-filter ^11.*$
Restrict access to databases whose name starts with 11
$ odoo-bin --database 11firstdatabase,11seconddatabase
Restrict access to only two databases, 11firstdatabase and 11seconddatabase
$ odoo-bin --database 11firstdatabase,11seconddatabase -u base
Restrict access to only two databases, 11firstdatabase and 11seconddatabase, and update base module on one database: 11firstdatabase. If database 11seconddatabase doesn’t exist, the database is created and base modules is installed
$ odoo-bin --db-filter ^11.*$ --database 11firstdatabase,11seconddatabase -u base
Restrict access to databases whose name starts with 11, and update base module on one database: 11firstdatabase. If database 11seconddatabase doesn’t exist, the database is created and base modules is installed
- --db-template <template>¶
when creating new databases from the database-management screens, use the specified template database. Defaults to
- --pg_path </path/to/postgresql/binaries>¶
Path to the PostgreSQL binaries that are used by the database manager to dump and restore databases. You have to specify this option only if these binaries are located in a non-standard directory.
Suppresses the ability to list databases available on the system
Control the SSL security of the connection between Odoo and PostgreSQL. Value should be one of ‘disable’, ‘allow’, ‘prefer’, ‘require’, ‘verify-ca’ or ‘verify-full’ Default value is ‘prefer’
Try to enable the unaccent extension when creating new databases
- --email-from <address>¶
Email address used as <FROM> when Odoo needs to send mails
- --from-filter <address or domain>¶
Define which email address the SMTP configuration will apply to. The field can be a domain name or an entire email address, or it can remain empty. If the sender’s email address does not match this set filter, then the email will be encapsulated using a combination of the two system parameters:
mail.catchall.domain. For example, “Admin” <email@example.com> => “Admin” <firstname.lastname@example.org>.
- --smtp <server>¶
Address of the SMTP server to connect to in order to send mails
- --smtp-port <port>¶
If set, odoo should use SSL/STARTSSL SMTP connections
- --smtp-user <name>¶
Username to connect to the SMTP server
- --smtp-password <password>¶
Password to connect to the SMTP server
- --smtp-ssl-certificate-filename <path/to/cert.pem>¶
An SSL certificate is to be used for authentication. If set, then
- --smtp-ssl-private-key-filename <path/to/key.pem>¶
An SSL private key is used for authentication. If set, then
Use these options to translate Odoo to another language. See i18n section of the user manual. Option ‘-d’ is mandatory. Option ‘-l’ is mandatory in case of importation
- --load-language <languages>¶
specifies the languages (separated by commas) for the translations you want to be loaded
- -l, --language <language>¶
specify the language of the translation file. Use it with –i18n-export or –i18n-import
- --i18n-export <filename>¶
export all sentences to be translated to a CSV file, a PO file or a TGZ archive and exit.
- --i18n-import <filename>¶
import a CSV or a PO file with translations and exit. The ‘-l’ option is required.
overwrites existing translation terms on updating a module or importing a CSV or a PO file.
specify modules to export. Use in combination with –i18n-export
- --dev <feature,feature,...,feature>¶
comma-separated list of features. For development purposes only. Do not use it in production. Possible features are:
all: all the features below are activated
xml: read QWeb template from xml file directly instead of database. Once a template has been modified in database, it will be not be read from the xml file until the next update/init. Particularly, templates are not translated on using this option.
reload: restart server when python file are updated (may not be detected depending on the text editor used)
qweb: break in the evaluation of QWeb template when a node contains
(i)p(u)db: start the chosen python debugger in the code when an unexpected error is raised before logging and returning the error.
werkzeug: display the full traceback on the frontend page in case of exception
do not start the HTTP or long-polling workers (may still start cron workers)
has no effect if
--test-enableis set, as tests require an accessible HTTP server
- --http-interface <interface>¶
TCP/IP address on which the HTTP server listens, defaults to
- -p <port>¶
- --http-port <port>¶
Port on which the HTTP server listens, defaults to 8069.
- --gevent-port <port>¶
TCP port for websocket connections in multiprocessing or gevent mode, defaults to 8072. Not used in default (threaded) mode.
enables the use of
X-Forwarded-*headers through Werkzeug’s proxy support.
It ignores all
X-Forwarded-*headers in case
X-Forwarded-Hostis missing from the request.
It always gets the real IP from the last entry of the
X-Forwarded-Forchain. Configure your web server accordingly using directives such as nginx’s set_real_ip_from in case there are other trusted proxies along the chain that must be ignored.
X-Forwarded-Hostare used to update the request root URL, which in turn is used to update the
web.base.urlsystem parameter upon a successful admin authentication. This system parameter is used to generate all links for the current database; see Web base URL of a database.
proxy mode must not be enabled outside of a reverse proxy scenario
By default, Odoo displays all logging of level
info except for workflow
warning only), and log output is sent to
options are available to redirect logging to other destinations and to
customize the amount of logging output.
- --logfile <file>¶
sends logging output to the specified file instead of stdout. On Unix, the file can be managed by external log rotation programs and will automatically be reopened when replaced
Neither is configurable
- --log-db <dbname>¶
logs to the
ir_loggingtable) of the specified database. The database can be the name of a database in the “current” PostgreSQL, or a PostgreSQL URI for e.g. log aggregation.
- --log-handler <handler-spec>¶
LOGGERat the provided
odoo.models:DEBUGwill enable all logging messages at or above
DEBUGlevel in the models.
The logger can be omitted to configure the root (default) handler
If the level is omitted, the logger is set to
The option can be repeated to configure multiple loggers e.g.
$ odoo-bin --log-handler :DEBUG --log-handler werkzeug:CRITICAL --log-handler odoo.fields:WARNING
enables DEBUG logging of HTTP requests and responses, equivalent to
enables DEBUG logging of SQL querying, equivalent to
- --log-level <level>¶
Shortcut to more easily set predefined levels on specific loggers. “real” levels (
debug) are set on the
werkzeugloggers (except for
debugwhich is only set on
Odoo also provides debugging pseudo-levels which apply to different sets of loggers:
sets the SQL logger to
odooand HTTP request loggers to
--log-level debug --log-request
odooand HTTP request and response loggers to
--log-level debug --log-request --log-response
- --workers <count>¶
countis not 0 (the default), enables multiprocessing and sets up the specified number of HTTP workers (sub-processes processing HTTP and RPC requests).
multiprocessing mode is only available on Unix-based systems
A number of options allow limiting and recycling workers:
- --limit-request <limit>¶
Number of requests a worker will process before being recycled and restarted.
Defaults to 8196.
- --limit-memory-soft <limit>¶
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.
Defaults to 2048MiB (2048*1024*1024B).
- --limit-memory-hard <limit>¶
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.
Defaults to 2560MiB (2560*1024*1024B).
- --limit-time-cpu <limit>¶
Prevents the worker from using more than <limit> CPU seconds for each request. If the limit is exceeded, the worker is killed.
Defaults to 60.
Most of the command-line options can also be specified via a configuration
file. Most of the time, they use similar names with the prefix
- are replaced by
Some conversions don’t match the pattern:
--no-httpcorresponds to the
--smtpis stored as
--databaseis stored as
The default configuration file is
can be overridden using
--save will save the current configuration state back
to that file. The configuration items relative to the command-line are to be
specified in the section
Here is a sample file:
[options] db_user=odoo dbfilter=odoo
Odoo command-line also allows to launch odoo as a python console environment. This enables direct interaction with the orm and its functionalities.
$ odoo-bin shell
- --shell-interface (ipython|ptpython|bpython|python)¶
Specify a preferred REPL to use in shell mode.
Scaffolding is the automated creation of a skeleton structure to simplify bootstrapping (of new modules, in the case of Odoo). While not necessary it avoids the tedium of setting up basic structures and looking up what all starting requirements are.
Scaffolding is available via the odoo-bin scaffold subcommand.
$ odoo-bin scaffold my_module /addons/
- name (required)¶
the name of the module to create, may munged in various manners to generate programmatic names (e.g. module directory name, model names, …)
- destination (default=current directory)¶
directory in which to create the new module, defaults to the current directory
- -t <template>¶
a template directory, files are passed through jinja2 then copied to the
This will create module my_module in directory /addons/.
Odoo CLI supports database population features. If the feature is implemented on a given model, it allows automatic data generation of the model’s records to test your modules in databases containing non-trivial amounts of records.
$ odoo-bin populate
list of models for which the database should be filled
- --size (small|medium|large)¶
population size, the actual records number depends on the model’s
_populate_sizesattribute. The generated records content is specified by the
_populate_factories()method of a given model (cf. the
populatefolder of modules for further details).
- -d <database>, --database <database>¶
--addons-pathoption is required to specify the path(s) to the module folder(s).
--path, the count will be that of the sum of both options’ results (with possible overlaps). At least one of these two options is required to specify which code to process.
$ odoo-bin cloc --addons-path=addons -d my_database
- -p <path>, --path <path>¶
--database, the count will be that of the sum of both options’ results (with possible overlaps). At least one of these two options is required to specify which code to process.
$ odoo-bin cloc -p addons/account
Multiple paths can be provided by repeating the option.
$ odoo-bin cloc -p addons/account -p addons/sale
- --addons-path <directories>¶
--databaseoption is used.
- -c <directories>¶
Specify a configuration file to use in place of the
$ odoo-bin cloc -c config.conf -d my_database
- -v, --verbose¶
Show the details of lines counted for each file.
Some files are excluded from the count by default:
The manifest (
The contents of the folder
The tests defined in the folder
The migrations scripts defined in the folder
The XML files declared in the
demo_xmlsections of the manifest
For special cases, a list of files that should be ignored by Odoo Cloc can be defined
per module. This is specified by the
cloc_exclude entry of the manifest:
"cloc_exclude": [ "lib/common.py", # exclude a single file "data/*.xml", # exclude all XML files in a specific folder "example/**/*", # exclude all files in a folder hierarchy recursively "**/*.scss", # exclude all scss file from the module ]
**/*can be used to ignore an entire module. This can be useful to exclude a module from maintenance service costs.
This method works the same as with the –database option if a manifest file is present in the given folder. Otherwise, it counts all files.
Identifying Extra Modules¶
To distinguish between standard and extra modules, Odoo Cloc uses the following heuristic:
modules that are located (real file system path, after following symbolic links)
in the same parent directory as the
standard modules are considered standard. Other modules are treated as extra modules.
Some file cannot be counted by Odoo Cloc. Those file are reported at the end of the output.
Max file size exceeded¶
Odoo Cloc rejects any file larger than 25MB. Usually, source files are smaller than 1 MB. If a file is rejected, it may be:
A generated XML file that contains lots of data. It should be excluded in the manifest.
Odoo Cloc cannot count the lines of code of a Python file with a syntax problem.
If an extra module contains such files, they should be fixed to allow the module to
load. If the module works despite the presence of those files, they are probably
not loaded and should therefore be removed from the module, or at least excluded
in the manifest via
The command to generate this files takes as many unnamed arguments as you need. Those are relative paths to your addon directories. In the example below, we move up one folder to save the tsconfig file in the folder containing community and enterprise.
$ community/odoo-bin tsconfig --addons-path community/addons,community/odoo/addons,enterprise > tsconfig.json