Command line utilities#
odootools#
odootools [OPTIONS] COMMAND [ARGS]...
Options
- -c, --config <config>#
- --exclude-odoo#
Exclude odoo paths from results
- --log-level <log_level>#
config#
odootools config [OPTIONS] COMMAND [ARGS]...
get#
odootools config get [OPTIONS] KEY
Options
- -s, --section <section>#
Arguments
- KEY#
Required argument
ls#
odootools config ls [OPTIONS]
path#
Display where is located the config file.
odootools config path [OPTIONS]
set#
odootools config set [OPTIONS] KEY VALUE
Options
- -s, --section <section>#
Arguments
- KEY#
Required argument
- VALUE#
Required argument
db#
odootools db [OPTIONS] COMMAND [ARGS]...
init#
Initialize a database with modules and some configurations.
odootools db init [OPTIONS] DATABASE
Options
- -m, --modules <modules>#
Modules to install
- --with-demo#
Generate new database with demo
- --country <country>#
Country two letter code
- -l, --language <language>#
Languages to use
Arguments
- DATABASE#
Required argument
list#
Get database list
odootools db list [OPTIONS]
Options
- --filter-missing#
- --filter-invalid#
- --filter-version <filter_version>#
- --include-extra-dbs#
Include databases not present in db_name
- -d, --db-name <db_name>#
explicit db_name value ignores config value
- --dbfilter <dbfilter>#
explicit dbfilter
- --hostname <hostname>#
entrypoint#
odootools entrypoint [OPTIONS] COMMAND [ARGS]...
preprocess#
odootools entrypoint preprocess [OPTIONS]
sudo#
odootools entrypoint sudo [OPTIONS] [PARAMS]...
Arguments
- PARAMS#
Optional argument(s)
user#
odootools entrypoint user [OPTIONS] [PARAMS]...
Arguments
- PARAMS#
Optional argument(s)
gen#
odootools gen [OPTIONS] COMMAND [ARGS]...
info#
odootools gen info [OPTIONS]
manage#
odootools manage [OPTIONS] COMMAND [ARGS]...
asset#
Build Asset
odootools manage asset [OPTIONS] TYPE ASSET
Options
- -d, --database <database>#
Database
- --minified#
Arguments
- TYPE#
Required argument
- ASSET#
Required argument
install#
Install modules in the provided database
odootools manage install [OPTIONS] DATABASE
Options
- -m, --modules <modules>#
Modules to install
- -f, --force#
Force module init
Arguments
- DATABASE#
Required argument
setup#
Install Odoo in the current environment.
odootools manage setup [OPTIONS] VERSION
Options
- --release <release>#
Release version from https://nightly.odoo.com
- --repo <repo>#
Repository
- --ref <ref>#
Git reference to fetch the code
- --languages <languages>#
Languages to keep
- --cache <cache>#
Cache directory
- --target <target>#
Target path in which to install
- --upgrade#
Upgrade pip packages while installing
Arguments
- VERSION#
Required argument
uninstall#
Uninstall specified modules from database
odootools manage uninstall [OPTIONS] DATABASE
Options
- -m, --modules <modules>#
Modules to install
Arguments
- DATABASE#
Required argument
update#
Update specified modules in a database.
odootools manage update [OPTIONS] DATABASE
Options
- -m, --modules <modules>#
Modules to install
Arguments
- DATABASE#
Required argument
module#
odootools module [OPTIONS] COMMAND [ARGS]...
deps#
odootools module deps [OPTIONS]
Options
- --only-name#
Only display module name instead of path
- --csv#
Only display module name instead of path
- --installable#
Output only installable modules
- --non-installable#
Output only non installable modules
- --without-version#
Display only modules without versions
- -m, --modules <modules>#
Only return modules that matches the provided module names.
- --csv-modules <csv_modules>#
Find all dependencies for modules input as csv
- -p, --path <path>#
Location in which to search
- --auto#
Include auto installed modules
- --include-modules#
Include dependencies that aren’t in the addons_paths.
- --quiet#
Remove logs and warnings.
- --exclude-modules#
Exclude queried modules from the found dependencies.
ls#
odootools module ls [OPTIONS]
Options
- --only-name#
Only display module name instead of path
- --csv#
Only display module name instead of path
- --installable#
Output only installable modules
- --non-installable#
Output only non installable modules
- --without-version#
Display only modules without versions
- -m, --modules <modules>#
Only return modules that matches the provided module names.
- -p, --path <path>#
Location in which to search
- --sorted#
Sort module in alphabetical number
requirements#
List requirements required by modules in addons_paths
odootools module requirements [OPTIONS]
Options
- --exclude <exclude>#
Exclude file paths
- -p, --path <path>#
Add custom requirements file path
- --add-rule <add_rule>#
Add extra requirements rule
- --package-map <package_map>#
Package map to resolve some modules that can’t be installed
- --lookup-requirements#
Lookup recursively requirements in addons_paths for a file named requirements.txt
- --sort#
Sort requirements in alphabetical order
show#
odootools module show [OPTIONS] MODULE
Arguments
- MODULE#
Required argument
path#
odootools path [OPTIONS] COMMAND [ARGS]...
add#
odootools path add [OPTIONS] ADDONS_PATH
Arguments
- ADDONS_PATH#
Required argument
ls#
odootools path ls [OPTIONS] [ADDONS_PATH]...
Options
- --sorted#
Sort paths
Arguments
- ADDONS_PATH#
Optional argument(s)
rm#
odootools path rm [OPTIONS] ADDONS_PATH
Arguments
- ADDONS_PATH#
Required argument
platform#
Print the platform name to the output.
odootools platform [OPTIONS] COMMAND [ARGS]...
arch#
odootools platform arch [OPTIONS]
service#
odootools service [OPTIONS] COMMAND [ARGS]...
checkout#
odootools service checkout [OPTIONS] SERVICE_FILE ENVIRONMENT TARGET
Options
- --cache <cache>#
- --decrypt-key <decrypt_key>#
- --credentials <credentials>#
Arguments
- SERVICE_FILE#
Required argument
- ENVIRONMENT#
Required argument
- TARGET#
Required argument
package#
odootools service package [OPTIONS] SERVICE_FILE ENVIRONMENT
Options
- --cache <cache>#
- --decrypt-key <decrypt_key>#
- -o, --output <output>#
Output file
Arguments
- SERVICE_FILE#
Required argument
- ENVIRONMENT#
Required argument
show#
odootools service show [OPTIONS] SERVICE_FILE ENV
Options
- --url <url>#
Default url for self
Arguments
- SERVICE_FILE#
Required argument
- ENV#
Required argument
shell#
odootools shell [OPTIONS] [PARAMS]...
Options
- -c, --config <config>#
Config file
- -d, --db <db>#
Database name
Arguments
- PARAMS#
Optional argument(s)
user#
odootools user [OPTIONS] COMMAND [ARGS]...
create#
odootools user create [OPTIONS] DB LOGIN NAME
Options
- --user-template <user_template>#
xmlid or id of the template
- --inactive#
Set new user as inactive
Arguments
- DB#
Required argument
- LOGIN#
Required argument
- NAME#
Required argument
ls#
odootools user ls [OPTIONS] DB
Options
- --internal#
Internal User
Shared User
- --inactive#
Inactive user
- --domain <domain>#
Custom domain
Arguments
- DB#
Required argument
remove#
odootools user remove [OPTIONS] DB LOGIN
Options
- --soft#
Mark user as inactive
Arguments
- DB#
Required argument
- LOGIN#
Required argument
reset-pw#
odootools user reset-pw [OPTIONS] DB LOGIN
Options
- --auto#
Auto generate password and output it.
- --no-password#
Remove password
- --no-password-policy#
Do not check password strength
Arguments
- DB#
Required argument
- LOGIN#
Required argument