Odood Command Reference
This page lists all commands available in Odood and their help messages.
odood
odood: Easily manage odoo installations. (dev)
USAGE
$ odood [-h] [--version] [-v] [-q] [-d] command
FLAGS
-h, --help prints help
--version prints version
-v, --verbose Enable verbose output
-q, --quiet Hide unnecessary output
-d, --debug Show additional debug information.
SUBCOMMANDS
Dev Tools:
pre-commit Work with pre-commit dev tool.
psql Run psql for specified database
script Run scripts in Odood environment.
translations Manage translations for this project.
Main:
addons Manage third-party addons.
assembly Manage assembly of this project
db Database management commands
deploy Deploy production-ready Odoo.
init Initialize new odood project.
odoo Odoo-related utility commands.
repo Manage git repositories.
server Server management commands.
status Show the project status.
test Run tests for mudles.
venv Manage virtual environment for this project.
Shortcuts:
browse Open odoo in browser
log View server logs.
lsa List addons in specified directory.
lsd Show the databases available for this odoo instance.
restart Restart the server running in background.
start Run the server in background.
stop Stop the server
tr Manage translations for this project.
ual Update list of addons.
System:
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 script
odood script: Run scripts in Odood environment.
USAGE
$ odood script [-h] py|sql
FLAGS
-h, --help prints help
SUBCOMMANDS
py Run Python script in this environment.
sql Run SQL script in this environment.
odood script py
odood script py: Run Python script in this environment.
USAGE
$ odood script py [-h] -d value script
FLAGS
-h, --help prints help
OPTIONS
-d, --db value Database to run script for
ARGUMENTS
script Path to script to run
odood script sql
odood script sql: Run SQL script in this environment.
USAGE
$ odood script sql [-h] [-n] -d value script
FLAGS
-h, --help prints help
-n, --no-commit Do not commit changes.
OPTIONS
-d, --db value Database to run script for
ARGUMENTS
script Path to script to run
odood odoo
odood odoo: Odoo-related utility commands.
USAGE
$ odood odoo [-h] recompute|shell
FLAGS
-h, --help prints help
SUBCOMMANDS
recompute Odoo-related utility commands.
shell Odoo-related utility commands.
odood odoo recompute
odood odoo recompute: Odoo-related utility commands.
USAGE
$ odood odoo recompute [-h] [--all-db] [-f value] [-d value] -m value
FLAGS
-h, --help prints help
--all-db Recompute for all databases.
OPTIONS
-f, --field value Name of field to recompute.
-d, --db value Name of database to recompute fields for.
-m, --model value Name of model to recompute fields for
odood odoo shell
odood odoo shell: Odoo-related utility commands.
USAGE
$ odood odoo shell [-h] [-d value]
FLAGS
-h, --help prints help
OPTIONS
-d, --db value Database(s) to run shell for.
odood restart
odood restart: Restart the server running in background.
USAGE
$ odood restart [-h] [-t value]
FLAGS
-h, --help prints help
OPTIONS
-t, --timeout value Timeout to wait while server starts (in seconds).
odood info
odood info: Print info about this Odood project.
USAGE
$ odood info [-h] [--json]
FLAGS
-h, --help prints help
--json Print output in json format
odood config
odood config: Manage config of the project
USAGE
$ odood config [-h] update
FLAGS
-h, --help prints help
SUBCOMMANDS
update Update the config.
odood config update
odood config update: Update the config.
USAGE
$ odood config update [-h]
FLAGS
-h, --help prints help
odood discover
odood discover: Discover already installed odoo, and configure Odood to manage it.
USAGE
$ odood discover [-h] odoo-helper
FLAGS
-h, --help prints help
SUBCOMMANDS
odoo-helper Discover odoo-helper-scripts project.
odood discover odoo-helper
odood discover odoo-helper: Discover odoo-helper-scripts project.
USAGE
$ odood discover odoo-helper [-h] [-s] [path]
FLAGS
-h, --help prints help
-s, --system Discover system (server-wide) odoo-helper project installation.
ARGUMENTS
path Try to discover odoo-helper project in specified path.
odood init
odood init: Initialize new odood project.
USAGE
$ odood init [options] -i value
FLAGS
-h, --help prints help
--pyenv Use python from pyenv to initialize virtualenv for project. Install desired py version if needed
--create-db-user [sudo] Create database user automatically during installation.Requires sudo.
OPTIONS
-i, --install-dir value Directory to install odoo to
-v, --odoo-version value Version of Odoo to install
--install-type value Installation type. Accept values: git, archive. Default: archive.
--odoo-branch value Branch in Odoo repo to install Odoo from.
--odoo-repo value Install Odoo from specific repository.
--py-version value Install specific python version. By default system python used
--node-version value Install specific node version.
--db-host value Database host
--db-port value Database port
--db-user value Database port
--db-password value Database password
--http-host value Http host
--http-port value Http port
odood tr
odood tr: Manage translations for this project.
USAGE
$ odood tr [-h] regenerate
FLAGS
-h, --help prints help
SUBCOMMANDS
regenerate Regenerate translations for specified addons.
odood tr regenerate
odood tr regenerate: Regenerate translations for specified addons.
USAGE
$ odood tr regenerate [options] [addon]
FLAGS
-h, --help prints help
--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
OPTIONS
--addon-dir value Directory to search for addons
--addon-dir-r value Directory to recursively search for addons
--lang-file value Combination of lang and file (separated by ':') to generate translations for. For example: uk_UA:uk.
-l, --lang value Language to generate translations for. For example: uk_UA.
ARGUMENTS
addon Specify names of addons as arguments.
odood log
odood log: View server logs.
USAGE
$ odood log [-h]
FLAGS
-h, --help prints help
odood ual
odood ual: Update list of addons.
USAGE
$ odood ual [-h] [-a] [database]
FLAGS
-h, --help prints help
-a, --all Update all databases.
ARGUMENTS
database Path to search for addons in.
odood addons
odood addons: Manage third-party addons.
USAGE
$ odood addons [-h] command
FLAGS
-h, --help prints help
SUBCOMMANDS
add Add addons to the project
find-installed List addons installed in specified databases
update-list Update list of addons.
link Link addons in specified directory.
generate-py-requirements Generate python's requirements.txt from addon's manifests. By default, it prints requirements to stdout.
update Update specified addons.
install Install specified addons.
is-installed Print list of databases wehre specified addon is installed.
uninstall Uninstall specified addons.
list List addons in specified directory.
odood addons add
odood addons add: Add addons to the project
USAGE
$ odood addons add [-h] [--single-branch] [-r] [--manifest-requirements] [--odoo-apps value] [--odoo-requirements value]
FLAGS
-h, --help prints help
--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
OPTIONS
--odoo-apps value Add addon from odoo apps.
--odoo-requirements value Add modules (repos) from odoo_requirements.txt file, that is used by odoo-helper-scripts.
odood addons find-installed
odood addons find-installed: List addons installed in specified databases
USAGE
$ odood addons find-installed [-h] [-a] [--non-system] [-d value] [-o value] [-f value]
FLAGS
-h, --help prints help
-a, --all Check all databases
--non-system List only custom addons, that are not default Odoo addons.
OPTIONS
-d, --db value Name of database to to check for addons.
-o, --out-file value Path to file where to store generated requirements
-f, --format value Output format. One of: list, assembnly-spec. Default: list.
odood addons update-list
odood addons update-list: Update list of addons.
USAGE
$ odood addons update-list [-h] [-a] [database]
FLAGS
-h, --help prints help
-a, --all Update all databases.
ARGUMENTS
database Path to search for addons in.
odood addons link
odood addons link: Link addons in specified directory.
USAGE
$ odood addons link [-h] [-f] [-r] [--manifest-requirements] [--ual] path
FLAGS
-h, --help prints help
-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
--ual Update addons list for all databases
ARGUMENTS
path Path to search for addons in.
odood addons generate-py-requirements
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 [-h] [-o value] [--dir value] [--dir-r value] [addon]
FLAGS
-h, --help prints help
OPTIONS
-o, --out-file value Path to file where to store generated requirements
--dir value Directory to search for addons to generate requirements.txt for.
--dir-r value Directory to recursively search for addons to generate requirements.txt for.
ARGUMENTS
addon Name of addon to generate manifest for.
odood addons update
odood addons update: Update specified addons.
USAGE
$ odood addons update [options] [addon]
FLAGS
-h, --help prints help
--assembly Search for addons available in assembly
--skip-errors Do not fail on errors during installation.
--start Start server after update (if everything is ok)
--ual Update addons list before install.
-a, --all Update all modules
OPTIONS
-d, --db value Database(s) to apply operation to.
--dir value Directory to search for addons
--dir-r value Directory to recursively search for addons
-f, --file value Read addons names from file (addon names must be separated by new lines)
--skip value Skip addon specified by name.
--skip-re value Skip addon specified by regex.
--skip-file value Skip addons listed in specified file (addon names must be separated by new lines)
ARGUMENTS
addon Specify names of addons as arguments.
odood addons install
odood addons install: Install specified addons.
USAGE
$ odood addons install [options] [addon]
FLAGS
-h, --help prints help
--assembly Search for addons available in assembly
--skip-errors Do not fail on errors during installation.
--start Start server after update (if everything is ok)
--ual Update addons list before install.
OPTIONS
-d, --db value Database(s) to apply operation to.
--dir value Directory to search for addons
--dir-r value Directory to recursively search for addons
-f, --file value Read addons names from file (addon names must be separated by new lines)
--skip value Skip addon specified by name.
--skip-re value Skip addon specified by regex.
--skip-file value Skip addons listed in specified file (addon names must be separated by new lines)
ARGUMENTS
addon Specify names of addons as arguments.
odood addons is-installed
odood addons is-installed: Print list of databases wehre specified addon is installed.
USAGE
$ odood addons is-installed [-h] addon
FLAGS
-h, --help prints help
ARGUMENTS
addon Name of addon or path to addon to check.
odood addons uninstall
odood addons uninstall: Uninstall specified addons.
USAGE
$ odood addons uninstall [options] [addon]
FLAGS
-h, --help prints help
--assembly Search for addons available in assembly
--skip-errors Do not fail on errors during installation.
--start Start server after update (if everything is ok)
OPTIONS
-d, --db value Database(s) to apply operation to.
--dir value Directory to search for addons
--dir-r value Directory to recursively search for addons
-f, --file value Read addons names from file (addon names must be separated by new lines)
--skip value Skip addon specified by name.
--skip-re value Skip addon specified by regex.
--skip-file value Skip addons listed in specified file (addon names must be separated by new lines)
ARGUMENTS
addon Specify names of addons as arguments.
odood addons list
odood addons list: List addons in specified directory.
USAGE
$ odood addons list [options] [path]
FLAGS
-h, --help prints help
--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
OPTIONS
-f, --field value Display provided field in table. This have to be valid field from manifest.
-c, --color value Color output by selected scheme: link - color addons by link status, installable - color addons by installable state.
ARGUMENTS
path Path to search for addons in.
odood lsa
odood lsa: List addons in specified directory.
USAGE
$ odood lsa [options] [path]
FLAGS
-h, --help prints help
--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
OPTIONS
-f, --field value Display provided field in table. This have to be valid field from manifest.
-c, --color value Color output by selected scheme: link - color addons by link status, installable - color addons by installable state.
ARGUMENTS
path Path to search for addons in.
odood pre-commit
odood pre-commit: Work with pre-commit dev tool.
USAGE
$ odood pre-commit [-h] run|init|set-up
FLAGS
-h, --help prints help
SUBCOMMANDS
run Run pre-commit for specified repo.
init Initialize pre-commit for this repo.
set-up Set up pre-commit for specified repo.
odood pre-commit run
odood pre-commit run: Run pre-commit for specified repo.
USAGE
$ odood pre-commit run [-h] [path]
FLAGS
-h, --help prints help
ARGUMENTS
path Path to repository to run pre-commit for.
odood pre-commit init
odood pre-commit init: Initialize pre-commit for this repo.
USAGE
$ odood pre-commit init [-h] [-f] [--no-setup] [path]
FLAGS
-h, --help prints help
-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.
ARGUMENTS
path Path to repository to initialize pre-commit.
odood pre-commit set-up
odood pre-commit set-up: Set up pre-commit for specified repo.
USAGE
$ odood pre-commit set-up [-h] [path]
FLAGS
-h, --help prints help
ARGUMENTS
path Path to repository to configure.
odood psql
odood psql: Run psql for specified database
USAGE
$ odood psql [-h] -d value
FLAGS
-h, --help prints help
OPTIONS
-d, --db value Name of database to connect to.
odood venv
odood venv: Manage virtual environment for this project.
USAGE
$ odood venv [-h] command
FLAGS
-h, --help prints help
SUBCOMMANDS
install-dev-tools Install Dev Tools
run Run command in this virtual environment. The command and all arguments must be specified after '--'. For example: 'odood venv run -- ipython'
reinstall-odoo Reinstall Odoo to different Odoo version.
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 python.
python Run python for this environment. All arguments after '--' will be forwarded directly to python.
update-odoo Update Odoo itself.
pip Run pip for this environment. All arguments after '--' will be forwarded directly to pip.
reinstall Reinstall virtualenv.
install-py-packages Install Python packages
odood venv install-dev-tools
odood venv install-dev-tools: Install Dev Tools
USAGE
$ odood venv install-dev-tools [-h]
FLAGS
-h, --help prints help
odood venv run
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 [-h]
FLAGS
-h, --help prints help
odood venv reinstall-odoo
odood venv reinstall-odoo: Reinstall Odoo to different Odoo version.
USAGE
$ odood venv reinstall-odoo [options]
FLAGS
-h, --help prints help
-b, --backup Backup Odoo before update.
--no-backup Do not take backup of Odoo and venv.
OPTIONS
--venv-py-version value Install specific python version.
--venv-node-version value Install specific node version.
--install-type value Installation type. Accept values: git, archive. Default: archive.
-v, --version value Odoo version to install.
odood venv npm
odood venv npm: Run npm for this environment. All arguments after '--' will be forwarded directly to npm.
USAGE
$ odood venv npm [-h]
FLAGS
-h, --help prints help
odood venv ipython
odood venv ipython: Run ipython in this environment. All arguments after '--' will be forwarded directly to python.
USAGE
$ odood venv ipython [-h]
FLAGS
-h, --help prints help
odood venv python
odood venv python: Run python for this environment. All arguments after '--' will be forwarded directly to python.
USAGE
$ odood venv python [-h]
FLAGS
-h, --help prints help
odood venv update-odoo
odood venv update-odoo: Update Odoo itself.
USAGE
$ odood venv update-odoo [-h] [-b]
FLAGS
-h, --help prints help
-b, --backup Backup Odoo before update.
odood venv pip
odood venv pip: Run pip for this environment. All arguments after '--' will be forwarded directly to pip.
USAGE
$ odood venv pip [-h]
FLAGS
-h, --help prints help
odood venv reinstall
odood venv reinstall: Reinstall virtualenv.
USAGE
$ odood venv reinstall [-h] [--py-version value] [--node-version value]
FLAGS
-h, --help prints help
OPTIONS
--py-version value Install specific python version.
--node-version value Install specific node version.
odood venv install-py-packages
odood venv install-py-packages: Install Python packages
USAGE
$ odood venv install-py-packages [-h] [-r value] [package]
FLAGS
-h, --help prints help
OPTIONS
-r, --requirements value Path to requirements.txt to install python packages from
ARGUMENTS
package Python package specification to install
odood db
odood db: Database management commands
USAGE
$ odood db [-h] command
FLAGS
-h, --help prints help
SUBCOMMANDS
exists Check if database exists.
restore Restore database.
populate Populate database with test data.
drop Drop the odoo database.
backup Backup database.
stun Stun (neutralize) database (disable cron and main servers).
create Create new odoo database.
rename Rename database.
list Show the databases available for this odoo instance.
copy Copy database.
odood db exists
odood db exists: Check if database exists.
USAGE
$ odood db exists [-h] [--q] name
FLAGS
-h, --help prints help
--q, --quiet Suppress output, just return exit code
ARGUMENTS
name Name of database
odood db restore
odood db restore: Restore database.
USAGE
$ odood db restore [-h] [--stun] [--selfish] [-f] [-r] name backup
FLAGS
-h, --help prints help
--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.
ARGUMENTS
name Name of database to restore.
backup Path to backup (or name of backup) to restore database from.
odood db populate
odood db populate: Populate database with test data.
USAGE
$ odood db populate [-h] -d value -m value [-s value] [--repeat value]
FLAGS
-h, --help prints help
OPTIONS
-d, --dbname value Name of database to populate.
-m, --model value Name of model to populate. Could be specified multiple times.
-s, --size value Population size
--repeat value Repeat population N times.
odood db drop
odood db drop: Drop the odoo database.
USAGE
$ odood db drop [-h] name
FLAGS
-h, --help prints help
ARGUMENTS
name Name of database
odood db backup
odood db backup: Backup database.
USAGE
$ odood db backup [-h] [--zip] [--sql] [-a] [-d value] [name]
FLAGS
-h, --help prints help
--zip Make ZIP backup with filestore.
--sql Make SQL-only backup without filestore
-a, --all Backup all databases
OPTIONS
-d, --dest value Destination path for backup. By default will store at project's backup directory.
ARGUMENTS
name Name of database to backup.
odood db stun
odood db stun: Stun (neutralize) database (disable cron and main servers).
USAGE
$ odood db stun [-h] name
FLAGS
-h, --help prints help
ARGUMENTS
name Name of database to stun.
odood db create
odood db create: Create new odoo database.
USAGE
$ odood db create [options] [name]
FLAGS
-h, --help prints help
-d, --demo Load demo data for this db
-r, --recreate Recreate database if it already exists.
--tdb Automatically generate default name of test database
OPTIONS
-l, --lang value Language of database, specified as ISO code of language.
--password value Admin password for this database.
--country value Country for this db.
-i, --install value Install module specified by name.
--install-dir value Install all modules from directory.
--install-file value Install all modules listed in specified file.
ARGUMENTS
name Name of database
odood db rename
odood db rename: Rename database.
USAGE
$ odood db rename [-h] old-name new-name
FLAGS
-h, --help prints help
ARGUMENTS
old-name Name of original database.
new-name New name of database.
odood db list
odood db list: Show the databases available for this odoo instance.
USAGE
$ odood db list [-h]
FLAGS
-h, --help prints help
odood db copy
odood db copy: Copy database.
USAGE
$ odood db copy [-h] old-name new-name
FLAGS
-h, --help prints help
ARGUMENTS
old-name Name of original database.
new-name New name of database.
odood server
odood server: Server management commands.
USAGE
$ odood server [-h] command
FLAGS
-h, --help prints help
SUBCOMMANDS
restart Restart the server running in background.
start Run the server in background.
run Run the server.
log View server logs.
stop Stop the server
browse Open odoo in browser
status Check if server is running
odood server restart
odood server restart: Restart the server running in background.
USAGE
$ odood server restart [-h] [-t value]
FLAGS
-h, --help prints help
OPTIONS
-t, --timeout value Timeout to wait while server starts (in seconds).
odood server start
odood server start: Run the server in background.
USAGE
$ odood server start [-h] [-t value]
FLAGS
-h, --help prints help
OPTIONS
-t, --timeout value Timeout to wait while server starts (in seconds).
odood server run
odood server run: Run the server.
USAGE
$ odood server run [-h] [--ignore-running]
FLAGS
-h, --help prints help
--ignore-running Ingore running Odoo instance. (Do not check/create pidfile).
odood server log
odood server log: View server logs.
USAGE
$ odood server log [-h]
FLAGS
-h, --help prints help
odood server stop
odood server stop: Stop the server
USAGE
$ odood server stop [-h]
FLAGS
-h, --help prints help
odood server browse
odood server browse: Open odoo in browser
USAGE
$ odood server browse [-h]
FLAGS
-h, --help prints help
odood server status
odood server status: Check if server is running
USAGE
$ odood server status [-h]
FLAGS
-h, --help prints help
odood browse
odood browse: Open odoo in browser
USAGE
$ odood browse [-h]
FLAGS
-h, --help prints help
odood status
odood status: Show the project status.
USAGE
$ odood status [-h]
FLAGS
-h, --help prints help
odood start
odood start: Run the server in background.
USAGE
$ odood start [-h] [-t value]
FLAGS
-h, --help prints help
OPTIONS
-t, --timeout value Timeout to wait while server starts (in seconds).
odood repo
odood repo: Manage git repositories.
USAGE
$ odood repo [-h] command
FLAGS
-h, --help prints help
SUBCOMMANDS
fix-series Fix series in manifests of addons in this repo. Set series to project's serie
add Add git repository to Odood project.
fix-version-conflict Fix version conflicts in manifests of addons in this repo.
do-forward-port [Experimental] Do forwardport changes from older branch.
check-versions Check changed addons has updated versions.
bump-versions Bump versions for modules that have changes (comparably to stable branch (17.0, 18.0, ...)).
migrate-addons Migrate code of addons that has older odoo serie to serie of this project.
odood repo fix-series
odood repo fix-series: Fix series in manifests of addons in this repo. Set series to project's serie
USAGE
$ odood repo fix-series [-h] [path]
FLAGS
-h, --help prints help
ARGUMENTS
path Path to repository to fix conflicts in.
odood repo add
odood repo add: Add git repository to Odood project.
USAGE
$ odood repo add [options] repo
FLAGS
-h, --help prints help
--oca Add Odoo Community Association (OCA) repository. If set, then 'repo' argument could be specified as name of repo under 'https://github.com/OCA' organuzation.
--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 wihth --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 clonned repo.
--ual Update addons list.
OPTIONS
-b, --branch value Branch to clone
ARGUMENTS
repo Repository URL to clone from.
odood repo fix-version-conflict
odood repo fix-version-conflict: Fix version conflicts in manifests of addons in this repo.
USAGE
$ odood repo fix-version-conflict [-h] [path]
FLAGS
-h, --help prints help
ARGUMENTS
path Path to repository to fix conflicts in.
odood repo do-forward-port
odood repo do-forward-port: [Experimental] Do forwardport changes from older branch.
USAGE
$ odood repo do-forward-port [-h] -s value [path]
FLAGS
-h, --help prints help
OPTIONS
-s, --source value Source branch to forwarport changes from
ARGUMENTS
path Path to repository to migrate addons in.
odood repo check-versions
odood repo check-versions: Check changed addons has updated versions.
USAGE
$ odood repo check-versions [-h] [--ignore-translations] [path]
FLAGS
-h, --help prints help
--ignore-translations Ignore translations.
ARGUMENTS
path Path to repository to search for addons to bump versions.
odood repo bump-versions
odood repo bump-versions: Bump versions for modules that have changes (comparably to stable branch (17.0, 18.0, ...)).
USAGE
$ odood repo bump-versions [-h] [--major] [--minor] [--patch] [--ignore-translations] [path]
FLAGS
-h, --help prints help
--major Increase major version for addons.
--minor Increase minor version for addons.
--patch Increase patch version for addons.
--ignore-translations Ignore translations.
ARGUMENTS
path Path to repository to search for addons to bump versions.
odood repo migrate-addons
odood repo migrate-addons: Migrate code of addons that has older odoo serie to serie of this project.
USAGE
$ odood repo migrate-addons [-h] [--commit] [-m value] [path]
FLAGS
-h, --help prints help
--commit Commit changes.
OPTIONS
-m, --module value Name of module to migrate
ARGUMENTS
path Path to repository to migrate addons in.
odood translations
odood translations: Manage translations for this project.
USAGE
$ odood translations [-h] regenerate
FLAGS
-h, --help prints help
SUBCOMMANDS
regenerate Regenerate translations for specified addons.
odood translations regenerate
odood translations regenerate: Regenerate translations for specified addons.
USAGE
$ odood translations regenerate [options] [addon]
FLAGS
-h, --help prints help
--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
OPTIONS
--addon-dir value Directory to search for addons
--addon-dir-r value Directory to recursively search for addons
--lang-file value Combination of lang and file (separated by ':') to generate translations for. For example: uk_UA:uk.
-l, --lang value Language to generate translations for. For example: uk_UA.
ARGUMENTS
addon Specify names of addons as arguments.
odood test
odood test: Run tests for mudles.
USAGE
$ odood test [options] [addon]
FLAGS
-h, --help prints help
-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.
--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.
--no-install-addons Do not install addons before test. Could be useful to speed up local tests.
OPTIONS
--coverage-fail-under value Fail if coverage is less then specified value.
-d, --db value Database to run tests for.
--additional-addon value Specify additional addon to install before test.
--dir value Directory to search for addons to test
--dir-r value Directory to recursively search for addons to test
-f, --file value Read addons names from file (addon names must be separated by new lines)
--skip value Skip (do not run tests) addon specified by name.
--skip-re value Skip (do not run tests) addon specified by regex.
--skip-file value Skip addons listed in specified file (addon names must be separated by new lines)
--migration-start-ref value git reference (branch/commit/tag) to start migration from
--migration-repo value run migration tests for repo specified by path
--populate-model value Name of model to populate. Could be specified multiple times.
--populate-size value Population size.
ARGUMENTS
addon Name of addon to run tests for.
odood assembly
odood assembly: Manage assembly of this project
USAGE
$ odood assembly [-h] [-p value] command
FLAGS
-h, --help prints help
OPTIONS
-p, --assembly-path value Path to assembly directory.
SUBCOMMANDS
link Link addons from this assembly to custom addons
sync Synchronize assembly with updates from sources.
init Initialize assembly for this project
use Use (attach) assembly located at specified path. Mostly useful in CI flows.
upgrade Upgrade assembly (optionally do backup, pull changes, update addons).
pull Pull updates for this assembly.
status Project assembly status
odood assembly link
odood assembly link: Link addons from this assembly to custom addons
USAGE
$ odood assembly link [-h] [--manifest-requirements] [--ual]
FLAGS
-h, --help prints help
--manifest-requirements Install python dependencies from manifest's external dependencies
--ual Update addons list for all databases
odood assembly sync
odood assembly sync: Synchronize assembly with updates from sources.
USAGE
$ odood assembly sync [options]
FLAGS
-h, --help prints help
--commit Commit changes.
--fail-nothing-to-commit Fail (set exit code = 1) if there is nothing to commit
--push Automatically push changes if needed.
--changelog Generate changelog for assembly.
OPTIONS
--commit-message value Commit message
--commit-user value Name of user to use for commit
--commit-email value Email of user to use for commit
--push-to value Name of branch to push changes to.
odood assembly init
odood assembly init: Initialize assembly for this project
USAGE
$ odood assembly init [-h] [--repo value]
FLAGS
-h, --help prints help
OPTIONS
--repo value Url to git repo with assembly to use for this project.
odood assembly use
odood assembly use: Use (attach) assembly located at specified path. Mostly useful in CI flows.
USAGE
$ odood assembly use [-h] path
FLAGS
-h, --help prints help
ARGUMENTS
path Path to already existing assembly.
odood assembly upgrade
odood assembly upgrade: Upgrade assembly (optionally do backup, pull changes, update addons).
USAGE
$ odood assembly upgrade [-h] [--backup] [--skip-errors] [--start]
FLAGS
-h, --help prints help
--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.
odood assembly pull
odood assembly pull: Pull updates for this assembly.
USAGE
$ odood assembly pull [-h] [--link]
FLAGS
-h, --help prints help
--link Relink addons in this assembly after pull
odood assembly status
odood assembly status: Project assembly status
USAGE
$ odood assembly status [-h]
FLAGS
-h, --help prints help
odood deploy
odood deploy: Deploy production-ready Odoo.
USAGE
$ odood deploy [options]
FLAGS
-h, --help prints help
--local-postgres Configure local postgresql server (requires PostgreSQL installed)
--proxy-mode Enable proxy-mode in odoo config
--local-nginx Autoconfigure local nginx (requires nginx installed)
--local-nginx-ssl Enable SSL for local nginx
--letsencrypt Enable Let's Encrypt configuration.
--enable-logrotate Enable logrotate for Odoo.
--enable-fail2ban Enable fail2ban for Odoo (requires fail2ban installed).
--log-to-stderr Log to stderr. Useful when running inside docker.
OPTIONS
-v, --odoo-version value Version of Odoo to install
--py-version value Install specific python version.
--node-version value Install specific node version.
--db-host value Database host
--db-port value Database port
--db-user value Database port
--db-password value Database password
--local-nginx-server-name value Servername for nginx config.
--local-nginx-ssl-cert value Path to SSL certificate for local nginx.
--local-nginx-ssl-key value Path to SSL key for local nginx.
--letsencrypt-email value Email for Let's Encrypt account.
--supervisor value What superwisor to use for deployment. One of: odood, init-script, systemd. Default: systemd.
--assembly-repo value Configure Odood to use assembly from this repo. Ensure, you have access to specified repo from this machine.
odood stop
odood stop: Stop the server
USAGE
$ odood stop [-h]
FLAGS
-h, --help prints help
odood lsd
odood lsd: Show the databases available for this odoo instance.
USAGE
$ odood lsd [-h]
FLAGS
-h, --help prints help