Project (of project)¶
Project lifecycle management commands.
of project new¶
Scaffold a new Odoo project with IaC manifest. By default no environment is created — use --no-env explicitly or omit it for an interactive prompt. Automatically creates .gitignore, README.md, and CHANGELOG.md files.
| Flag | Default | Description |
|---|---|---|
--name, -n |
— | Project name |
--author, -a |
config default | Author name |
--image |
config default | Base Odoo Docker image |
--version, -v |
config default | Odoo version |
--production, -P |
false |
Production environment |
--domain, -d |
— | Domain name (required for production) |
--port |
auto | Dev port |
--websecure, -w |
false |
Enable Let's Encrypt |
--users, -u |
5 |
Concurrent users estimate |
--ram, -r |
auto |
RAM in GB or auto |
--master-password, -mp |
auto-generated | Admin password |
--command, -c |
— | Custom Odoo command |
--repos |
— | JSON array of repos |
--no-env, -ne |
true |
Skip environment creation (default: no env, interactive prompt offered) |
--init |
false |
Run project init after creation |
--yes, -y |
false |
Skip confirmation |
--json |
false |
JSON output |
--db-name |
— | Default database name |
--hide-db-list/--no-hide-db-list |
— | Hide DB list from login |
| Flag | Default | Description |
|---|---|---|
--name, -n |
— | Project name |
--author, -a |
config default | Author name |
--image |
config default | Base Odoo Docker image |
--version, -v |
config default | Odoo version |
--production, -P |
false |
Production environment |
--domain, -d |
— | Domain name (required for production) |
--port |
auto | Dev port |
--websecure, -w |
false |
Enable Let's Encrypt |
--users, -u |
5 |
Concurrent users estimate |
--ram, -r |
auto |
RAM in GB or auto |
--master-password, -mp |
auto-generated | Admin password |
--command, -c |
— | Custom Odoo command |
--repos |
— | JSON array of repos |
--no-env, -ne |
false |
Skip environment creation |
--init |
false |
Run project init after creation |
--yes, -y |
false |
Skip confirmation |
--json |
false |
JSON output |
--db-name |
— | Default database name |
--hide-db-list/--no-hide-db-list |
— | Hide DB list from login |
of project init¶
Build infrastructure for all environments in project.yml.
| Flag | Default | Description |
|---|---|---|
--up, -u |
false |
Start after init |
--force |
false |
Force init: overwrite existing environments (regenerate docker-compose.yml) |
--json |
false |
JSON output |
--db-name |
— | Default database name |
--hide-db-list/--no-hide-db-list |
— | Hide DB list from login |
of project check¶
System Doctor — verify Docker, Git repos, container status, logs, ports, and odoo.conf validity per environment.
Checks for:
- System dependencies (Docker, Compose, Git)
- Environment directory structure
- Container status and log errors
- Port binding
- odoo.conf and .env validity
- Repository clone status
- URL accessibility — for environments with a domain (server.domain), performs an HTTPS request (falling back to HTTP) and reports whether the site is reachable
- Hardcoded token warnings — alerts when any repository token is a plain string instead of a ${VAR} reference
| Flag | Default | Description |
|---|---|---|
--json |
false |
JSON output |
of project ls¶
List all projects (running, stopped, or inactive).
| Flag | Default | Description |
|---|---|---|
--json |
false |
JSON output |
of project set-master-password [password]¶
Change project master password across project.yml, .env, and odoo.conf for all environments.
| Argument | Description |
|---|---|
password |
New password (optional with --random) |
| Flag | Default | Description |
|---|---|---|
--random, -r |
false |
Generate random password |
--env, -e |
all | Target specific environment |
--json |
false |
JSON output |