Odoo BuildOdoo Build
Home
Help
Images
Snippets
Revisions
Modules
Changelog
Mint System
Chat
GitHub
Home
Help
Images
Snippets
Revisions
Modules
Changelog
Mint System
Chat
GitHub
  • Home

    • Home
    • Help
    • Images
    • Snippets
    • Revisions
    • Modules
    • Changelog
CommandOptionDescription
activate-venvActivate virtualenv.
add-git-submodule[url] [path]Add git submodule.
build[Dockerfile][platform]Build Odoo Container image. Optionally define the target platform.
build-vuepressCreate Vuepress build.
change-uuid[env]Change database uuid via xmlrpc.
checkout[version]Checkout Odoo version.
checkout-git-folderCheckout git commit.
checkout-latest-revision[version]Checkout the latest revision of the Odoo version.
checkout-revision[revision]Run Odoo revision script or checkout revision set by env var.
commit-with-llmCommit with llm generated commit message.
clean-git-folderClean git folder.
clear-assets[db]Clear all assets of Odoo database.
clear-filestore[db]Clear local filestore folder. No param will clear all filestores.
clear-views[db]Clear all views of Odoo database.
clock-odoo[db]Count custom line of codes.
clone-git-folderClone git folder listed in the .gitmodules file.
commit-git-folder[message][path]Commit all changes in path.
container-login[user][pass]Setup container hub login credentials.
container-psList container processes.
create-git-feature-branch[path]Create feature branch for Odoo module.
create-git-mig-branch[path]Create migration branch for Odoo module.
create-module[path]Create new Odoo module from template.
create-module-repo[path]Initialize Odoo module repo from template.
create-nextcloud-env[env]Create env file for Nextcloud instance.
create-odoo-env[env]Create env file for Odoo Instance.
create-revision[revision]Create new Odoo revision.
create-snippet[id]Create snippet from template.
debug[name]Debugg application. Options: native.
delete-git-folderDelete all git folders.
dev-vuepressStart Vuepress development server.
disable-mailserver[env]Disable mail server settings via xmlrpc.
disable-snippet[env][path]Disable snippet definition.
drop-db[db]Drop target Odoo database.
edit-env[env]Open env file in default editor.
generate-admin-passwd[pass]Generate hash for Odoo master password.
generate-module-docs[path]Generate readme file for module.
generate-module-model[path][model]Generate model in module folder.
generate-module-inherit[path][model]Generate inherited model in module folder.
generate-module-views[path][model]Generate model views in module folder.
generate-module-security[path][model]Generate model access file.
generate-module-snippet[path][ref]Generate snippet for referefenced view.
generate-module-wizard[path][model]Generate wizard for a model in module folder.
get-addons-pathOutput addons path.
status-git-folder[path]Show status for git folder in path.
get-modules[path][option]Get list of modules in path. Option is 'basename' or 'dirname'.
get-module-version[path]Get module version from manifest.
import-csv[db][path]Import data from csv. Filename must match PostgreSQL table name.
infoShow values of project env vars.
init-db[db]Initialize the Odoo database.
init-module[db][path,module]Initialize Odoo module.
init-venvInitialize python virtual env.
install-nativeInstall Odoo requirements in source folder.
install-odoo-scriptsInstall Odoo scripts.
install-requirements[db][path]Install python packages from requirements.txt.
install-snippet[env][path]Install snippet definition.
install-vuepressInstall Node build dependencies.
lint-module[path]Run pylint odoo for module.
lint-module-repo[path]Run pylint odoo for modules in repo folder.
lint-snippetsRun checks for all snippets.
list-envList env files.
list-git-folder[grep]List path and url of git folders.
list-modules[path]Get modules in path as list.
list-revisionList available Odoo revisions.
list-versionsList available Odoo versions.
load-env[env]Load and export env file.
load-language[db][lang]Install language package in Odoo db.
load-version[version]Load git refs from version folder.
load-ssh-keyLoad SSH private key from env var.
logs[name]Tail container logs. Default is 'odoo'.
ls-module[grep]List Odoo addons path space separated.
ls-git-folder[grep]List git folders path space separated.
odoocli[param]Execute odoocli cli.
patch-database[db][path]Apply sql file to database.
publish[Dockerfile]Publish Odoo container image.
pull-git-folderPull all git folders listed in the .gitmodules file.
push-git-folderPush all git folders in path.
pytest-module[db][name,path]Run module tests with pytest.
release-module[path]Create GitHub release for a module.
remove[name]Remove containers and volumes. Options: none, db, admin, odoo, mail.
remove-env[env]Remove environment config.
remove-git-submodule[path]Remove a git submodule.
remove-module[db][name]Remove target Odoo module.
remove-snippet[env][path]Remove snippet definition.
record-with-memray[name]Record application memory usage with memray. Options: native.
record-with-py-spy[pid]Record and create flamechart for a process.
reset-git-folderAbort rebase and reset submodules listed in the .gitmodules file.
reset-views[db][key]Execute hard reset on views matching keys.
restart[name]Restart container.
restore-dotenvRestore content of .env from pass entry.
run[name][cmd]Run container with command.
save-versionSave git folder refs to version folder.
serve-vuepressServe Vuepress build.
set-addons-pathSet Odoo addons path env variable.
set-admin[db]Sets the password for the first user in database.
setup-mail[db]Setup mail config in Odoo db.
setup-mail-sql[db]Setup mail config in Odoo db with SQL.
show-env[env]Output content of the env file.
show-revision[revision]Show references of Odoo revision.
sourceSource the Python virtual env.
stage-git-folder[path]Stage all files in git folders in path.
start[name][db]Start application. Options: db, admin, odoo, native, mail.
start-psql[db]Start PSQL shell in container container.
start-shell[db]Start Odoo shell from source folder.
stop[name]Stop containers.
store-dotenvStore content of .env in pass entry.
switch-git-folder[version]Switch branch for all git folders listed in the .gitmodules file.
sync-git-folderSwitch, stash and pull all git folders.
template-composeTemplate the Docker compose file.
template-odoo-rcTemplate the Odoo config file.
template-repo[path]Update the repo folder from template.
test-image[Dockerfile]Test Odoo container image.
test-module[db][name,path]Test target Odoo module.
test-module-repo[db][path]Test target Odoo modules in repo folder.
test-project[clean]Run tests for this project.
test-xmlrpc[env]Test json rpc connection.
translate-module[db][path][lang]Generate translation for Odoo module.
update-docsUpdate project docs.
update-help-docsWrite help table to task.md file.
update-module[db][name,path]Update target Odoo module.
update-module-license[grep]Update LICENSE file for each matching module.
update-module-list[db]Update module list.
update-module-docsUpdate modules docs file.
update-repo-docs[path]Update Readme file of the repo.
update-revision-docsUpdate revisions doc file.
update-snippet[env][path]Update snippet definition.
update-snippet-docsUpdate snippets doc file.
update-with-llm[path][prompt]Feed module files with prompt to LLM and apply file changes.
upgrade-module[path][version]Upgrade code of module from target Odoo version.
upgrade-odoo[db][version][mode]Run the Odoo upgrade scripts. Default mode ist 'test'.
upload-module[env][path]Zip and upload Odoo module.
versionShow version of required tools.
visualize-dependencies[path]Generate visualizations of module dependencies.
zip-module[path]Create zip file for module.
Edit this page
Last Updated:
Contributors: Janik von Rotz
Prev
Home
Next
Images