Odood Command Reference

odood

Easily manage odoo installations.

Usage:

odood [options] <command>

Options:

Flag	Description
`-v`, `--verbose`	Enable verbose output
`-q`, `--quiet`	Hide unnecessary output
`-d`, `--debug`	Show additional debug information.
`-h`, `--help`	Show this help
`--version`	Show version

Shortcuts:

Name	Expands to	Description
`start`	`server start`	Run the server in background.
`stop`	`server stop`	Stop the server.
`restart`	`server restart`	Restart the server.
`browse`	`server browse`	Open odoo in browser.
`log`	`server log`	View server logs.
`lsd`	`db list`	Show databases.
`lsa`	`addons list`	List addons.
`ual`	`addons update-list`	Update list of addons.
`tr`	`translations`	Manage translations.

Commands:

init — Initialize new odood project.
deploy — Deploy production-ready Odoo.
server — Server management commands.
status — Show the project status.
db — Database management commands
addons — Manage third-party addons.
test — Run tests for modules.
repo — Manage git repositories.
venv — Manage virtual environment for this project.
odoo — Odoo-related utility commands.
assembly — Manage assembly of this project
script — Run scripts in Odood environment.
psql — Run psql for specified database
pre-commit — Work with pre-commit dev tool.
translations — Manage translations for this project.
config — Manage config of the project
discover — Discover already installed odoo, and configure Odood to manage it.
info — Print info about this Odood project.

odood init

Initialize new odood project.

Usage:

odood init [options]

Options:

Flag	Description
`-i`, `--install-dir`	Directory to install odoo to
`-v`, `--odoo-version`	Version of Odoo to install
`--install-type`	Installation type. Accept values: git, archive. Default: archive.
`--odoo-branch`	Branch in Odoo repo to install Odoo from.
`--odoo-repo`	Install Odoo from specific repository.
`--pyenv`	Use python from pyenv to initialize virtualenv for project. Install desired py version if needed
`--py-version`	Install specific python version. By default system python used
`--node-version`	Install specific node version.
`--db-host`	Database host
`--db-port`	Database port
`--db-user`	Database user
`--db-password`	Database password
`--create-db-user`	[sudo] Create database user automatically during installation. Requires sudo.
`--http-host`	Http host
`--http-port`	Http port
`--log-to-stderr`	Configure project without a log file (logs to stdout/stderr). Recommended for container deployments.
`-h`, `--help`	Show this help

odood deploy

Deploy production-ready Odoo.

Usage:

odood deploy [options]

Options:

Flag	Description
`-v`, `--odoo-version`	Version of Odoo to install
`--py-version`	Install specific python version.
`--node-version`	Install specific node version.
`--db-host`	Database host
`--db-port`	Database port
`--db-user`	Database user
`--db-password`	Database password
`--local-postgres`	Configure local postgresql server (requires PostgreSQL installed)
`-w`, `--workers`	Number of workers to apply for this instance. If set to 0, then Odoo will be started in threaded mode. Default: 0
`--proxy-mode`	Enable proxy-mode in odoo config
`--local-nginx`	Autoconfigure local nginx (requires nginx installed)
`--local-nginx-server-name`	Servername for nginx config.
`--local-nginx-ssl`	Enable SSL for local nginx
`--local-nginx-ssl-cert`	Path to SSL certificate for local nginx.
`--local-nginx-ssl-key`	Path to SSL key for local nginx.
`--tls12-compat`	Allow TLS 1.2 in addition to TLS 1.3 for backward compatibility with older clients. By default, only TLS 1.3 is enabled.
`--letsencrypt`	Enable Let’s Encrypt configuration.
`--letsencrypt-email`	Email for Let’s Encrypt account.
`--enable-logrotate`	Enable logrotate for Odoo.
`--enable-fail2ban`	Enable fail2ban for Odoo (requires fail2ban installed).
`--supervisor`	What supervisor to use for deployment. One of: odood, init-script, systemd. Default: systemd.
`--log-to-stderr`	Log to stderr. Useful when running inside docker.
`--use-system-ca-bundle`	Set REQUESTS_CA_BUNDLE to the system CA certificate store, so Odoo uses system certificates instead of the bundled certifi CA bundle.
`--assembly-repo`	Configure Odood to use assembly from this repo. Ensure, you have access to specified repo from this machine.
`-h`, `--help`	Show this help

odood server

Server management commands.

Usage:

odood server <command>

Options:

Flag	Description
`-h`, `--help`	Show this help

Commands:

run — Run the server.
start — Run the server in background.
status — Check if server is running
stop — Stop the server
restart — Restart the server running in background.
browse — Open odoo in browser
log — View server logs.
healthcheck — Check if the Odoo HTTP server is healthy. Exits 0 if healthy, 1 if not.
wait-pg — Wait for PostgreSQL to become available.

odood server run

Run the server.

Usage:

odood server run [options]

Options:

Flag	Description
`--ignore-running`	Ignore running Odoo instance. (Do not check/create pidfile).
`--wait-pg`	Wait for PostgreSQL to be ready before starting the server.
`--wait-pg-timeout`	Maximum time to wait for PostgreSQL in seconds.
`-h`, `--help`	Show this help

odood server start

Run the server in background.

Usage:

odood server start [options]

Options:

Flag	Description
`-t`, `--timeout`	Timeout to wait while server starts (in seconds).
`-h`, `--help`	Show this help

odood server status

Check if server is running

Usage:

odood server status

Options:

Flag	Description
`-h`, `--help`	Show this help

odood server stop

Stop the server

Usage:

odood server stop

Options:

Flag	Description
`-h`, `--help`	Show this help

odood server restart

Restart the server running in background.

Usage:

odood server restart [options]

Options:

Flag	Description
`-t`, `--timeout`	Timeout to wait while server starts (in seconds).
`-h`, `--help`	Show this help

odood server browse

Open odoo in browser

Usage:

odood server browse

Options:

Flag	Description
`-h`, `--help`	Show this help

odood server log

View server logs.

Usage:

odood server log

Options:

Flag	Description
`-h`, `--help`	Show this help

odood server healthcheck

Check if the Odoo HTTP server is healthy. Exits 0 if healthy, 1 if not.

Usage:

odood server healthcheck [options]

Options:

Flag	Description
`-t`, `--timeout`	HTTP request timeout in seconds.
`-h`, `--help`	Show this help

odood server wait-pg

Wait for PostgreSQL to become available.

Usage:

odood server wait-pg [options]

Options:

Flag	Description
`-t`, `--timeout`	Maximum time to wait in seconds.
`--interval`	Time between connection attempts in seconds.
`-h`, `--help`	Show this help

odood status

Show the project status.

Usage:

odood status

Options:

Flag	Description
`-h`, `--help`	Show this help

odood db

Database management commands

Usage:

odood db <command>

Options:

Flag	Description
`-h`, `--help`	Show this help

Commands:

list — Show the databases available for this odoo instance.
create — Create new odoo database.
ensure-initialized — Ensure a database exists and is initialized as an Odoo database. Idempotent: safe to use in K8s init containers.
drop — Drop the odoo database.
exists — Check if database exists.
is-initialized — Check if database is initialized as an Odoo database.
rename — Rename database.
copy — Copy database.
backup — Backup database.
restore — Restore database.
stun — Stun (neutralize) database (disable cron and mail servers).
populate — Populate database with test data.

odood db list

Show the databases available for this odoo instance.

Usage:

odood db list

Options:

Flag	Description
`-h`, `--help`	Show this help

odood db create

Create new odoo database.

Usage:

odood db create [options] <name>

Options:

Flag	Description
`-d`, `--demo`	Load demo data for this db
`-r`, `--recreate`	Recreate database if it already exists.
`--tdb`	Automatically generate default name of test database
`-l`, `--lang`	Language of database, specified as ISO code of language.
`--password`	Admin password for this database.
`--country`	Country for this db.
`-i`, `--install`	Install module specified by name.
`--install-dir`	Install all modules from directory.
`--install-file`	Install all modules listed in specified file.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`name`	Name of database

odood db ensure-initialized

Ensure a database exists and is initialized as an Odoo database. Idempotent: safe to use in K8s init containers.

Usage:

odood db ensure-initialized [options] <name>

Options:

Flag	Description
`--wait-pg`	Wait for PostgreSQL to be ready before proceeding.
`--wait-pg-timeout`	Maximum time to wait for PostgreSQL in seconds.
`-d`, `--demo`	Load demo data (only on first initialization).
`-l`, `--lang`	Language code, e.g. en_US (only on first initialization).
`-h`, `--help`	Show this help

Arguments:

Name	Description
`name`	Name of database.

odood db drop

Drop the odoo database.

Usage:

odood db drop <name>

Options:

Flag	Description
`-h`, `--help`	Show this help

Arguments:

Name	Description
`name`	Name of database(s) to drop.

odood db exists

Check if database exists.

Usage:

odood db exists [options] <name>

Options:

Flag	Description
`-q`, `--quiet`	Suppress output, just return exit code
`-h`, `--help`	Show this help

Arguments:

Name	Description
`name`	Name of database

odood db is-initialized

Check if database is initialized as an Odoo database.

Usage:

odood db is-initialized [options] <name>

Options:

Flag	Description
`-q`, `--quiet`	Suppress output, just return exit code.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`name`	Name of database.

odood db rename

Rename database.

Usage:

odood db rename <old-name> <new-name>

Options:

Flag	Description
`-h`, `--help`	Show this help

Arguments:

Name	Description
`old-name`	Name of original database.
`new-name`	New name of database.

odood db copy

Copy database.

Usage:

odood db copy <old-name> <new-name>

Options:

Flag	Description
`-h`, `--help`	Show this help

Arguments:

Name	Description
`old-name`	Name of original database.
`new-name`	New name of database.

odood db backup

Backup database.

Usage:

odood db backup [options] <name>

Options:

Flag	Description
`--zip`	Make ZIP backup with filestore.
`--sql`	Make SQL-only backup without filestore
`-a`, `--all`	Backup all databases
`-d`, `--dest`	Destination path for backup. By default will store at project’s backup directory.
`--nice`	Lower the CPU priority of the backup by the given nice increment (1-19, higher = lower priority).
`-h`, `--help`	Show this help

Arguments:

Name	Description
`name`	Name of database(s) to backup.

odood db restore

Restore database.

Usage:

odood db restore [options] <name> <backup>

Options:

Flag	Description
`--stun`	Stun database (disable cron and mail servers)
`--selfish`	Stop the server while database being restored.
`-f`, `--force`	Enforce restore, even if backup is not valid.
`-r`, `--recreate`	Recreate database if it already exists.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`name`	Name of database to restore.
`backup`	Path to backup (or name of backup) to restore database from.

odood db stun

Stun (neutralize) database (disable cron and mail servers).

Usage:

odood db stun <name>

Options:

Flag	Description
`-h`, `--help`	Show this help

Arguments:

Name	Description
`name`	Name of database to stun.

odood db populate

Populate database with test data.

Usage:

odood db populate [options]

Options:

Flag	Description
`-d`, `--dbname`	Name of database to populate.
`-m`, `--model`	Name of model to populate. Could be specified multiple times.
`-s`, `--size`	Population size
`--repeat`	Repeat population N times.
`-h`, `--help`	Show this help

odood addons

Manage third-party addons.

Usage:

odood addons <command>

Options:

Flag	Description
`-h`, `--help`	Show this help

Commands:

link — Link addons in specified directory.
update-list — Update list of addons.
list — List addons in specified directory.
update — Update specified addons.
install — Install specified addons.
uninstall — Uninstall specified addons.
add — Add addons to the project
is-installed — Print list of databases where specified addon is installed.
generate-py-requirements — Generate python’s requirements.txt from addon’s manifests. By default, it prints requirements to stdout.
find-installed — List addons installed in specified databases

odood addons link

Link addons in specified directory.

Usage:

odood addons link [options] <path>

Options:

Flag	Description
`-f`, `--force`	Rewrite already linked/existing addon.
`-r`, `--recursive`	Search for addons in this directory recursively.
`--manifest-requirements`	Install python dependencies from manifest’s external dependencies
`--individual-requirements`	Install Python requirements per-addon instead of batched
`--with-odoo-requirements`	Include Odoo’s requirements.txt in the batch install
`--ual`	Update addons list for all databases
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to search for addons in.

odood addons update-list

Update list of addons.

Usage:

odood addons update-list [options] <database>

Options:

Flag	Description
`-a`, `--all`	Update all databases.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`database`	Database(s) to update addons list for.

odood addons list

List addons in specified directory.

Usage:

odood addons list [options] <path>

Options:

Flag	Description
`--by-path`	Display addons by paths.
`--by-name`	Display addons by name (default).
`--by-name-version`	Display addon name with addon version
`-s`, `--system`	Search for all addons available for Odoo.
`-r`, `--recursive`	Search for addons recursively.
`--installable`	Filter only installable addons.
`--not-installable`	Filter only not-installable addons.
`--linked`	Filter only linked addons.
`--not-linked`	Filter only addons that are not linked.
`--with-price`	Filter only addons that has price defined.
`--without-price`	Filter only addons that does not have price defined.
`--assembly`	Show addons available in assembly
`-t`, `--table`	Display list of addons as table
`-f`, `--field`	Display provided field in table. This have to be valid field from manifest.
`-c`, `--color`	Color output by selected scheme: link - color addons by link status, installable - color addons by installable state.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to search for addons in.

odood addons update

Update specified addons.

Usage:

odood addons update [options] <addon>

Options:

Flag	Description
`-d`, `--db`	Database(s) to apply operation to.
`--dir`	Directory to search for addons
`--dir-r`	Directory to recursively search for addons
`-f`, `--file`	Read addons names from file (addon names must be separated by new lines)
`--assembly`	Search for addons available in assembly
`--skip`	Skip addon specified by name.
`--skip-re`	Skip addon specified by regex.
`--skip-file`	Skip addons listed in specified file (addon names must be separated by new lines)
`--skip-errors`	Do not fail on errors during installation.
`--ignore-unfinished-updates`	Do not fail if there are unfinished addon install/update/uninstall operations.
`--start`	Start server after update (if everything is ok)
`--ual`	Update addons list before update.
`-a`, `--all`	Update all modules
`--installed-only`	Skip addons that are not installed in the database.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`addon`	Names of addons to operate on.

odood addons install

Install specified addons.

Usage:

odood addons install [options] <addon>

Options:

Flag	Description
`-d`, `--db`	Database(s) to apply operation to.
`--dir`	Directory to search for addons
`--dir-r`	Directory to recursively search for addons
`-f`, `--file`	Read addons names from file (addon names must be separated by new lines)
`--assembly`	Search for addons available in assembly
`--skip`	Skip addon specified by name.
`--skip-re`	Skip addon specified by regex.
`--skip-file`	Skip addons listed in specified file (addon names must be separated by new lines)
`--skip-errors`	Do not fail on errors during installation.
`--ignore-unfinished-updates`	Do not fail if there are unfinished addon install/update/uninstall operations.
`--start`	Start server after update (if everything is ok)
`--ual`	Update addons list before install.
`--missing-only`	Skip addons that are already installed in the database.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`addon`	Names of addons to operate on.

odood addons uninstall

Uninstall specified addons.

Usage:

odood addons uninstall [options] <addon>

Options:

Flag	Description
`-d`, `--db`	Database(s) to apply operation to.
`--dir`	Directory to search for addons
`--dir-r`	Directory to recursively search for addons
`-f`, `--file`	Read addons names from file (addon names must be separated by new lines)
`--assembly`	Search for addons available in assembly
`--skip`	Skip addon specified by name.
`--skip-re`	Skip addon specified by regex.
`--skip-file`	Skip addons listed in specified file (addon names must be separated by new lines)
`--skip-errors`	Do not fail on errors during installation.
`--ignore-unfinished-updates`	Do not fail if there are unfinished addon install/update/uninstall operations.
`--start`	Start server after update (if everything is ok)
`-h`, `--help`	Show this help

Arguments:

Name	Description
`addon`	Names of addons to operate on.

odood addons add

Add addons to the project

Usage:

odood addons add [options]

Options:

Flag	Description
`--single-branch`	Clone repository with –single-branch options. This could significantly reduce size of data to be downloaded and increase performance.
`-r`, `--recursive`	Recursively process odoo_requirements.txt. If set, then Odood will automatically process odoo_requirements.txt file inside repositories mentioned in provided odoo_requirements.txt
`--manifest-requirements`	Install python dependencies from manifest’s external dependencies
`--odoo-apps`	Add addon from odoo apps.
`--odoo-requirements`	Add modules (repos) from odoo_requirements.txt file (or directory containing odoo_requirements.txt), that is used by odoo-helper-scripts.
`-h`, `--help`	Show this help

odood addons is-installed

Print list of databases where specified addon is installed.

Usage:

odood addons is-installed <addon>

Options:

Flag	Description
`-h`, `--help`	Show this help

Arguments:

Name	Description
`addon`	Name of addon or path to addon to check.

odood addons generate-py-requirements

Generate python’s requirements.txt from addon’s manifests. By default, it prints requirements to stdout.

Usage:

odood addons generate-py-requirements [options] <addon>

Options:

Flag	Description
`-o`, `--out-file`	Path to file where to store generated requirements
`--dir`	Directory to search for addons to generate requirements.txt for.
`--dir-r`	Directory to recursively search for addons to generate requirements.txt for.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`addon`	Name of addon to generate requirements for.

odood addons find-installed

List addons installed in specified databases

Usage:

odood addons find-installed [options]

Options:

Flag	Description
`-d`, `--db`	Name of database to check for addons.
`-o`, `--out-file`	Path to file where to store result
`-f`, `--format`	Output format. One of: list, assembly-spec. Default: list.
`-a`, `--all`	Check all databases
`--non-system`	List only custom addons, that are not default Odoo addons.
`-h`, `--help`	Show this help

odood test

Run tests for modules.

Usage:

odood test [options] <addon>

Options:

Flag	Description
`-t`, `--temp-db`	Create temporary database for tests.
`--no-drop-db`	Do not drop temporary database after test completed.
`--isw`	Ignore warnings that are considered safe.
`--simplified-log`	Display simplified log messages.
`--migration`	Run migration against stable branch.
`--coverage`	Calculate code coverage.
`--coverage-report`	Print coverage report.
`--coverage-html`	Prepare HTML report for coverage.
`--coverage-skip-covered`	Skip covered files in coverage report.
`--coverage-ignore-errors`	Ignore coverage errors.
`--coverage-fail-under`	Fail if coverage is less than specified value.
`--no-error-report`	Do not print error report in the end of the test.
`--error-report`	Print error report in the end of the test.
`--warning-report`	Print warning report in the end of the test.
`-d`, `--db`	Database to run tests for.
`--additional-addon`	Specify additional addon to install before test.
`--no-install-addons`	Do not install addons before test. Could be useful to speed up local tests.
`--dir`	Directory to search for addons to test
`--dir-r`	Directory to recursively search for addons to test
`-f`, `--file`	Read addons names from file (addon names must be separated by new lines)
`--skip`	Skip (do not run tests) addon specified by name.
`--skip-re`	Skip (do not run tests) addon specified by regex.
`--skip-file`	Skip addons listed in specified file (addon names must be separated by new lines)
`--migration-start-ref`	git reference (branch/commit/tag) to start migration from
`--migration-repo`	run migration tests for repo specified by path
`--migration-last-release`	Start migration test from the latest release tag. Fails if no release tags exist for the current Odoo serie.
`--populate-model`	Name of model to populate. Could be specified multiple times.
`--populate-size`	Population size.
`--test-tag`	Filter tests by tag (Odoo 12.0+). Repeatable. Supports Odoo tag syntax: plain tags, /module, /module:Class.method, -tag to exclude.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`addon`	Names of addons to run tests for.

odood repo

Manage git repositories.

Usage:

odood repo <command>

Options:

Flag	Description
`-h`, `--help`	Show this help

Commands:

add — Add git repository to Odood project.
pull-all — [Experimental] Pull changes from all repos and relink addons.
fix-version-conflict — Fix version conflicts in manifests of addons in this repo.
fix-series — Fix series in manifests of addons in this repo. Set series to project’s serie
bump-versions — Bump versions for modules that have changes (comparably to stable branch).
check-versions — Check changed addons has updated versions.
migrate-addons — Migrate code of addons that has older odoo serie to serie of this project.
do-forward-port — [Experimental] Do forwardport changes from older branch.
release — Release addon repository: auto-version, tag, and optionally push.
hotfix — Manage hotfix (patch) releases on dedicated hotfix branches.

odood repo add

Add git repository to Odood project.

Usage:

odood repo add [options] <repo>

Options:

Flag	Description
`--oca`	Add Odoo Community Association (OCA) repository. If set, then ‘repo’ argument could be specified as name of repo under ‘https://github.com/OCA’ organization.
`--github`	Add github repository. If set, then ‘repo’ argument could be specified as ‘owner/name’ that will be converted to ‘https://github.com/owner/name’.
`--single-branch`	Clone repository with –single-branch options. This could significantly reduce size of data to be downloaded and increase performance.
`-r`, `--recursive`	If set, then system will automatically fetch recursively dependencies of this repository, specified in odoo_requirements.txt file inside cloned repo.
`-b`, `--branch`	Branch to clone
`--ual`	Update addons list.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`repo`	Repository URL to clone from.

odood repo pull-all

[Experimental] Pull changes from all repos and relink addons.

Usage:

odood repo pull-all

Options:

Flag	Description
`-h`, `--help`	Show this help

odood repo fix-version-conflict

Fix version conflicts in manifests of addons in this repo.

Usage:

odood repo fix-version-conflict <path>

Options:

Flag	Description
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository to fix conflicts in.

odood repo fix-series

Fix series in manifests of addons in this repo. Set series to project’s serie

Usage:

odood repo fix-series <path>

Options:

Flag	Description
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository to fix conflicts in.

odood repo bump-versions

Bump versions for modules that have changes (comparably to stable branch).

Usage:

odood repo bump-versions [options] <path>

Options:

Flag	Description
`--major`	Increase major version for addons.
`--minor`	Increase minor version for addons.
`--patch`	Increase patch version for addons.
`--ignore-translations`	Ignore translations.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository to search for addons to bump versions.

odood repo check-versions

Check changed addons has updated versions.

Usage:

odood repo check-versions [options] <path>

Options:

Flag	Description
`--ignore-translations`	Ignore translations.
`--since-last-release`	Compare against the latest release tag instead of the stable branch tip. Shows exactly what ‘odood repo release’ will verify.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository to search for addons to bump versions.

odood repo migrate-addons

Migrate code of addons that has older odoo serie to serie of this project.

Usage:

odood repo migrate-addons [options] <path>

Options:

Flag	Description
`-m`, `--module`	Name of module to migrate
`--commit`	Commit changes.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository to migrate addons in.

odood repo do-forward-port

[Experimental] Do forwardport changes from older branch.

Usage:

odood repo do-forward-port [options] <path>

Options:

Flag	Description
`-s`, `--source`	Source branch to forwardport changes from
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository to migrate addons in.

odood repo release

Release addon repository: auto-version, tag, and optionally push.

Usage:

odood repo release [options] <path>

Options:

Flag	Description
`--initial`	Create the first release for a repository with no prior tags at version .1.0.0. Skips change detection and version checking.
`--major`	Force a major version bump.
`--minor`	Force a minor version bump.
`--patch`	Force a patch version bump.
`--ignore-translations`	Ignore translation files (.po/.pot) when detecting changes.
`--fail-nothing-to-release`	Exit with code 1 when no changed addons are detected.
`--push`	Push the release tag (and branch) to origin.
`--changelog`	Generate CHANGELOG.md and CHANGELOG.latest.md and commit them before tagging.
`--commit-message`	Commit message for the changelog commit (default: ‘Release ’).
`--commit-user`	Git author name for the changelog commit.
`--commit-email`	Git author email for the changelog commit.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository to release (default: current directory).

odood repo hotfix

Manage hotfix (patch) releases on dedicated hotfix branches.

Usage:

odood repo hotfix <command>

Options:

Flag	Description
`-h`, `--help`	Show this help

Commands:

start — Set up a hotfix branch from a primary release tag. Run this before ‘odood repo hotfix release’.
check — Check addon versions on the current hotfix branch against the latest tag in its patch chain. Previews what ‘odood repo hotfix release’ will verify.
release — Release a hotfix (patch) on the current hotfix branch: bump Z on top of the chain’s latest tag, tag, and optionally push.

odood repo hotfix start

Set up a hotfix branch from a primary release tag. Run this before ‘odood repo hotfix release’.

Usage:

odood repo hotfix start [options] <path>

Options:

Flag	Description
`--from`	Primary release tag to patch (e.g. 18.0.2.1.0). Must have Z == 0.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository (default: current directory).

odood repo hotfix check

Check addon versions on the current hotfix branch against the latest tag in its patch chain. Previews what ‘odood repo hotfix release’ will verify.

Usage:

odood repo hotfix check [options] <path>

Options:

Flag	Description
`--ignore-translations`	Ignore translation files (.po/.pot) when detecting changes.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository (default: current directory).

odood repo hotfix release

Release a hotfix (patch) on the current hotfix branch: bump Z on top of the chain’s latest tag, tag, and optionally push.

Usage:

odood repo hotfix release [options] <path>

Options:

Flag	Description
`--ignore-translations`	Ignore translation files (.po/.pot) when detecting changes.
`--fail-nothing-to-release`	Exit with code 1 when no changed addons are detected.
`--push`	Push the release tag (and branch) to origin.
`--changelog`	Generate CHANGELOG.md and CHANGELOG.latest.md and commit them before tagging.
`--commit-message`	Commit message for the changelog commit (default: ‘Release ’).
`--commit-user`	Git author name for the changelog commit.
`--commit-email`	Git author email for the changelog commit.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository (default: current directory).

odood venv

Manage virtual environment for this project.

Usage:

odood venv <command>

Options:

Flag	Description
`-h`, `--help`	Show this help

Commands:

install-dev-tools — Install Dev Tools
install-py-packages — Install Python packages
reinstall — Reinstall virtualenv.
update-odoo — Update Odoo itself.
reinstall-odoo — Reinstall Odoo to different Odoo version.
pip — Run pip for this environment. All arguments after ‘–’ will be forwarded directly to pip.
npm — Run npm for this environment. All arguments after ‘–’ will be forwarded directly to npm.
ipython — Run ipython in this environment. All arguments after ‘–’ will be forwarded directly to IPython.
python — Run python for this environment. All arguments after ‘–’ will be forwarded directly to python.
lodoo — Run lodoo in this environment. All arguments after ‘–’ will be forwarded directly to lodoo.
run — Run command in this virtual environment. The command and all arguments must be specified after ‘–’. For example: ‘odood venv run – ipython’

odood venv install-dev-tools

Install Dev Tools

Usage:

odood venv install-dev-tools

Options:

Flag	Description
`-h`, `--help`	Show this help

odood venv install-py-packages

Install Python packages

Usage:

odood venv install-py-packages [options] <package>

Options:

Flag	Description
`-r`, `--requirements`	Path to requirements.txt to install python packages from
`-h`, `--help`	Show this help

Arguments:

Name	Description
`package`	Python package specification to install.

odood venv reinstall

Reinstall virtualenv.

Usage:

odood venv reinstall [options]

Options:

Flag	Description
`--py-version`	Install specific python version.
`--node-version`	Install specific node version.
`-h`, `--help`	Show this help

odood venv update-odoo

Update Odoo itself.

Usage:

odood venv update-odoo [options]

Options:

Flag	Description
`-b`, `--backup`	Backup Odoo before update.
`-h`, `--help`	Show this help

odood venv reinstall-odoo

Reinstall Odoo to different Odoo version.

Usage:

odood venv reinstall-odoo [options]

Options:

Flag	Description
`-b`, `--backup`	Backup Odoo before update.
`--no-backup`	Do not take backup of Odoo and venv.
`--venv-py-version`	Install specific python version.
`--venv-node-version`	Install specific node version.
`--install-type`	Installation type. Accept values: git, archive. Default: archive.
`-v`, `--version`	Odoo version to install.
`-h`, `--help`	Show this help

odood venv pip

Run pip for this environment. All arguments after ‘–’ will be forwarded directly to pip.

Usage:

odood venv pip

Options:

Flag	Description
`-h`, `--help`	Show this help

odood venv npm

Run npm for this environment. All arguments after ‘–’ will be forwarded directly to npm.

Usage:

odood venv npm

Options:

Flag	Description
`-h`, `--help`	Show this help

odood venv ipython

Run ipython in this environment. All arguments after ‘–’ will be forwarded directly to IPython.

Usage:

odood venv ipython

Options:

Flag	Description
`-h`, `--help`	Show this help

odood venv python

Run python for this environment. All arguments after ‘–’ will be forwarded directly to python.

Usage:

odood venv python

Options:

Flag	Description
`-h`, `--help`	Show this help

odood venv lodoo

Run lodoo in this environment. All arguments after ‘–’ will be forwarded directly to lodoo.

Usage:

odood venv lodoo

Options:

Flag	Description
`-h`, `--help`	Show this help

odood venv run

Run command in this virtual environment. The command and all arguments must be specified after ‘–’. For example: ‘odood venv run – ipython’

Usage:

odood venv run

Options:

Flag	Description
`-h`, `--help`	Show this help

odood odoo

Odoo-related utility commands.

Usage:

odood odoo <command>

Options:

Flag	Description
`-h`, `--help`	Show this help

Commands:

shell — Run an interactive Odoo shell.
recompute — Recompute stored fields for a model.

odood odoo shell

Run an interactive Odoo shell.

Usage:

odood odoo shell [options]

Options:

Flag	Description
`-d`, `--db`	Database to run shell for.
`-h`, `--help`	Show this help

odood odoo recompute

Recompute stored fields for a model.

Usage:

odood odoo recompute [options]

Options:

Flag	Description
`-f`, `--field`	Name of field to recompute.
`-d`, `--db`	Name of database to recompute fields for.
`--all-db`	Recompute for all databases.
`-m`, `--model`	Name of model to recompute fields for
`-h`, `--help`	Show this help

odood assembly

Manage assembly of this project

Usage:

odood assembly [options] <command>

Options:

Flag	Description
`-p`, `--assembly-path`	Path to assembly directory.
`-h`, `--help`	Show this help

Commands:

init — Initialize assembly for this project
use — Use (attach) assembly located at specified path. Mostly useful in CI flows.
status — Project assembly status
sync — Synchronize assembly with updates from sources.
link — Link addons from this assembly to custom addons
pull — Pull updates for this assembly.
upgrade — Upgrade assembly (optionally do backup, pull changes, update addons).
upgrade-sources — Upgrade assembly source refs to the latest version tags on their remotes.

odood assembly init

Initialize assembly for this project

Usage:

odood assembly init [options]

Options:

Flag	Description
`--repo`	Url to git repo with assembly to use for this project.
`-h`, `--help`	Show this help

odood assembly use

Use (attach) assembly located at specified path. Mostly useful in CI flows.

Usage:

odood assembly use <path>

Options:

Flag	Description
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to already existing assembly.

odood assembly status

Project assembly status

Usage:

odood assembly status

Options:

Flag	Description
`-h`, `--help`	Show this help

odood assembly sync

Synchronize assembly with updates from sources.

Usage:

odood assembly sync [options]

Options:

Flag	Description
`--commit`	Commit changes.
`--commit-message`	Commit message
`--commit-user`	Name of user to use for commit
`--commit-email`	Email of user to use for commit
`--fail-nothing-to-commit`	Fail (set exit code = 1) if there is nothing to commit
`--push`	Automatically push changes if needed.
`--push-to`	Name of branch to push changes to.
`--changelog`	Generate changelog for assembly.
`--dockerfile`	Generate Dockerfile for assembly.
`--generate-lock`	Generate requirements.lock.txt after syncing
`--with-odoo-requirements`	Include Odoo’s requirements.txt when generating lock file
`-h`, `--help`	Show this help

odood assembly link

Link addons from this assembly to custom addons

Usage:

odood assembly link [options]

Options:

Flag	Description
`--manifest-requirements`	Install python dependencies from manifest’s external dependencies
`--individual-requirements`	Install Python requirements per-addon instead of batched
`--with-odoo-requirements`	Include Odoo’s requirements.txt in the batch install
`--ual`	Update addons list for all databases
`-h`, `--help`	Show this help

odood assembly pull

Pull updates for this assembly.

Usage:

odood assembly pull [options]

Options:

Flag	Description
`--link`	Relink addons in this assembly after pull
`-h`, `--help`	Show this help

odood assembly upgrade

Upgrade assembly (optionally do backup, pull changes, update addons).

Usage:

odood assembly upgrade [options]

Options:

Flag	Description
`--backup`	Do backup of all databases
`--skip-errors`	Continue upgrade next databases if upgrade of db had error.
`--start`	Start the server if upgrade completed successfully and server was not running before upgrade.
`-h`, `--help`	Show this help

odood assembly upgrade-sources

Upgrade assembly source refs to the latest version tags on their remotes.

Usage:

odood assembly upgrade-sources [options]

Options:

Flag	Description
`--commit`	Commit the updated spec.
`--commit-message`	Commit message.
`--commit-user`	Name of user to use for commit.
`--commit-email`	Email of user to use for commit.
`--push`	Push changes after committing.
`--push-to`	Name of branch to push changes to.
`-h`, `--help`	Show this help

odood script

Run scripts in Odood environment.

Usage:

odood script <command>

Options:

Flag	Description
`-h`, `--help`	Show this help

Commands:

py — Run Python script in this environment.
sql — Run SQL script in this environment.

odood script py

Run Python script in this environment.

Usage:

odood script py [options] <script>

Options:

Flag	Description
`-d`, `--db`	Database to run script for
`-h`, `--help`	Show this help

Arguments:

Name	Description
`script`	Path to script to run

odood script sql

Run SQL script in this environment.

Usage:

odood script sql [options] <script>

Options:

Flag	Description
`-d`, `--db`	Database to run script for
`-n`, `--no-commit`	Do not commit changes.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`script`	Path to script to run

odood psql

Run psql for specified database

Usage:

odood psql [options]

Options:

Flag	Description
`-d`, `--db`	Name of database to connect to.
`-h`, `--help`	Show this help

odood pre-commit

Work with pre-commit dev tool.

Usage:

odood pre-commit <command>

Options:

Flag	Description
`-h`, `--help`	Show this help

Commands:

init — Initialize pre-commit for this repo.
set-up — Set up pre-commit for specified repo.
update — Update pre-commit for specified repo.
run — Run pre-commit for specified repo.

odood pre-commit init

Initialize pre-commit for this repo.

Usage:

odood pre-commit init [options] <path>

Options:

Flag	Description
`-f`, `--force`	Enforce initialization. This will rewrite pre-commit configurations.
`--no-setup`	Do not set up pre-commit. Could be used if pre-commit already set up.
`--odoo-helper-compat`	Generate pre-commit config compatible with odoo-helper linting style (check-only, no auto-formatting).
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository to initialize pre-commit.

odood pre-commit set-up

Set up pre-commit for specified repo.

Usage:

odood pre-commit set-up <path>

Options:

Flag	Description
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository to configure.

odood pre-commit update

Update pre-commit for specified repo.

Usage:

odood pre-commit update <path>

Options:

Flag	Description
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository to configure.

odood pre-commit run

Run pre-commit for specified repo.

Usage:

odood pre-commit run <path>

Options:

Flag	Description
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Path to repository to run pre-commit for.

odood translations

Manage translations for this project.

Usage:

odood translations <command>

Options:

Flag	Description
`-h`, `--help`	Show this help

Commands:

regenerate — Regenerate translations for specified addons.

odood translations regenerate

Regenerate translations for specified addons.

Usage:

odood translations regenerate [options] <addon>

Options:

Flag	Description
`--pot-remove-dates`	Remove dates from generated .pot file.
`--pot`	Generate .pot file for translations.
`--pot-update`	Update translations based on regenerated .pot file.
`--missing-only`	Generate only missing translations.
`--no-drop-db`	Do not drop database after regeneration of translations
`--addon-dir`	Directory to search for addons
`--addon-dir-r`	Directory to recursively search for addons
`--lang-file`	Combination of lang and file (separated by ‘:’) to generate translations for. For example: uk_UA:uk.
`-l`, `--lang`	Language to generate translations for. For example: uk_UA.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`addon`	Names of addons to regenerate translations for.

odood config

Manage config of the project

Usage:

odood config <command>

Options:

Flag	Description
`-h`, `--help`	Show this help

Commands:

update — Update the config.

odood config update

Update the config.

Usage:

odood config update

Options:

Flag	Description
`-h`, `--help`	Show this help

odood discover

Discover already installed odoo, and configure Odood to manage it.

Usage:

odood discover <command>

Options:

Flag	Description
`-h`, `--help`	Show this help

Commands:

odoo-helper — Discover odoo-helper-scripts project.

odood discover odoo-helper

Discover odoo-helper-scripts project.

Usage:

odood discover odoo-helper [options] <path>

Options:

Flag	Description
`-s`, `--system`	Discover system (server-wide) odoo-helper project installation.
`-h`, `--help`	Show this help

Arguments:

Name	Description
`path`	Try to discover odoo-helper project in specified path.

odood info

Print info about this Odood project.

Usage:

odood info [options]

Options:

Flag	Description
`--json`	Print output in json format
`-h`, `--help`	Show this help

Keyboard shortcuts

Odood - master Odoo magic with ease.