Environment (of env)¶
Manage Odoo environments — start, stop, configure, and monitor.
of env up [env]¶
Start an environment (default: main).
| Flag | Default | Description |
|---|---|---|
-v, --verbose |
false |
Show live Docker logs |
--json |
false |
JSON output |
of env down [env]¶
Stop an environment.
| Flag | Default | Description |
|---|---|---|
--json |
false |
JSON output |
of env restart [env]¶
Restart an environment.
| Flag | Default | Description |
|---|---|---|
-v, --verbose |
false |
Verbose output |
--json |
false |
JSON output |
of env pull [env]¶
Pre-pull base images (Odoo, PostgreSQL).
| Flag | Default | Description |
|---|---|---|
--json |
false |
JSON output |
of env init [env]¶
Initialize from project.yml — build Dockerfile, clone repos, generate config.
| Flag | Default | Description |
|---|---|---|
--up, -u |
false |
Start after init |
--json |
false |
JSON output |
--db-name |
— | Default database name |
--hide-db-list/--no-hide-db-list |
— | Hide DB list from login |
of env rm [env]¶
Remove an environment folder and optionally containers/volumes.
| Flag | Default | Description |
|---|---|---|
--all |
false |
Remove both project and environment |
--yes, -y |
false |
Skip confirmation |
--json |
false |
JSON output |
of env new¶
Create a new environment (dev or staging).
| Flag | Default | Description |
|---|---|---|
--name, -n |
— | Environment name |
--image, -i |
config default | Docker image |
--version |
config default | Odoo version |
--production, -P |
false |
Production mode |
--staging, -s |
false |
Staging mode (clones main) |
--domain, -d |
— | Domain (production) |
--port |
auto | Dev port |
--users, -u |
5 |
Concurrent users |
--ram, -r |
auto |
RAM in GB |
--websecure, -w |
false |
Let's Encrypt |
--command, -c |
— | Custom Odoo command |
--repos |
— | JSON array of repos |
--preinstall |
— | Pre-build shell commands |
--postinstall |
— | Post-build shell commands |
--yes, -y |
false |
Skip confirmation |
--json |
false |
JSON output |
--db-name |
— | Default database name |
--hide-db-list/--no-hide-db-list |
— | Hide DB list |
of env status [env]¶
Show container status and health.
| Flag | Default | Description |
|---|---|---|
--json |
false |
JSON output |
of env ls¶
List all environments across projects.
| Flag | Default | Description |
|---|---|---|
--json |
false |
JSON output |
of env url [env]¶
Show formatted access URL.
| Flag | Default | Description |
|---|---|---|
--json |
false |
JSON output |
of env logs [env]¶
View Odoo container logs.
| Flag | Default | Description |
|---|---|---|
--tail, -t |
all | Number of lines |
--json |
false |
JSON output (requires --tail) |
of env shell [env] [db]¶
Open interactive odoo shell.
| Argument | Default | Description |
|---|---|---|
env |
main |
Environment name |
db |
odoo |
Database name |
of env stats [env]¶
Live resource monitor (CPU/RAM/IO), refreshes every 0.5s.
| Flag | Default | Description |
|---|---|---|
--json |
false |
Single snapshot as JSON |
of env conf [env]¶
View or modify odoo.conf.
| Flag | Description |
|---|---|
--users, -u |
Set workers based on user count |
--ram, -r |
Set memory limits (GB) |
--auto-ram |
Auto-calculate from server specs |
--admin-passwd |
Change admin password |
--db-user |
PostgreSQL user |
--db-password |
PostgreSQL password |
--proxy-mode |
Enable proxy mode |
--db-name |
Set default database |
--clear-db-name |
Remove default DB (show picker) |
--hide-db-list/--no-hide-db-list |
Toggle DB list |
--set key=value |
Set arbitrary config key |
--unset key |
Remove config key |
--show |
Display current config |
--restart, -r |
Restart after applying |
--json |
JSON output |
of env check [env]¶
Runtime health check — containers, logs, DB connectivity, port, odoo.conf, .env, repos.
| Flag | Default | Description |
|---|---|---|
--json |
false |
JSON output |
of env update [env] [db]¶
Update modules + optionally git and server config.
| Flag | Default | Description |
|---|---|---|
--module, -m |
all | Specific module to update |
--git, -g |
false |
Update all repos from git |
--so |
false |
Update server options |
--stash, -s |
false |
Stash changes before git pull |
--restart, -r |
false |
Restart after update |
-v, --verbose |
false |
Verbose output |
--json |
false |
JSON output |
--db-name |
— | Default database name |
--hide-db-list/--no-hide-db-list |
— | Hide DB list |
of env install [env] [db] [module]¶
Install an Odoo module.
| Flag | Default | Description |
|---|---|---|
-v, --verbose |
false |
Show install logs |
--json |
false |
JSON output |
of env uninstall [env] [db] [module]¶
Uninstall an Odoo module.
| Flag | Default | Description |
|---|---|---|
-v, --verbose |
false |
Show uninstall logs |
--json |
false |
JSON output |
of env modules [env] [db]¶
List all or installed modules.
| Flag | Default | Description |
|---|---|---|
--installed, -i |
false |
Only installed modules |
--json |
false |
JSON output |
of env password [env] [db] [user] [password]¶
Reset any user password via DB injection.
| Flag | Default | Description |
|---|---|---|
--random, -r |
false |
Generate random password |
--json |
false |
JSON output |
of env restore [env] [backup_path]¶
Restore a .zip backup to an environment.
| Flag | Default | Description |
|---|---|---|
--db |
from manifest | Target database name |
--yes, -y |
false |
Skip confirmation |
--json |
false |
JSON output |