@@ -10,6 +10,7 @@ argument-hint: "[configure|update|status] [instance_name] [options]"
1010Deploy and manage application instances on remote servers over SSH using the [ ` deploy ` ] ( https://github.com/trobz/deploy.py ) CLI tool.
1111
1212Supports three deployment types:
13+
1314- ** ` odoo ` ** — Odoo projects (auto-detected from ` odoo- ` / ` openerp- ` prefix)
1415- ** ` python ` ** — Generic Python services (FastAPI, Flask, workers, etc.)
1516- ** ` service ` ** — Any non-Python application where build/start commands are operator-defined
@@ -50,7 +51,7 @@ uv tool install uv # usually pre-installed
5051
5152## Instance Name Convention
5253
53- ```
54+ ``` bash
5455< type_prefix> -< project_slug> -< environment> [-< suffix> ]
5556```
5657
@@ -61,7 +62,8 @@ uv tool install uv # usually pre-installed
6162| ` suffix ` | Optional: ` -02 ` , ` -eu ` , ` -vn ` |
6263
6364** Examples:**
64- ```
65+
66+ ``` bash
6567odoo-myproject-production
6668odoo-myproject-staging-02
6769service-myapi-production-eu
@@ -128,11 +130,13 @@ deploy configure <instance_name> [ssh_host] [repo_url] [--type odoo|python|servi
128130` ` `
129131
130132**Options:**
133+
131134- ` --type` — Override auto-detected type
132135- ` --force` — Re-run setup even if the instance directory already exists
133136- `-p` — SSH port (default : 22)
134137
135138**Examples:**
139+
136140` ` ` bash
137141# Odoo instance (type auto-detected from "odoo-" prefix)
138142deploy configure odoo-myproject-staging deploy@server.example.com git@github.com:org/repo.git
@@ -148,6 +152,7 @@ deploy configure odoo-myproject-staging --force
148152` ` `
149153
150154**What it does:**
155+
1511561. Connects via SSH (or runs locally if no `ssh_host`)
1521572. Clones the repo into `~/<instance_name>` on the remote host
1531583. Sets up the environment :
@@ -167,10 +172,12 @@ deploy [--config FILE] update <instance_name> [ssh_host] [-p PORT] [--type odoo|
167172` ` `
168173
169174**Options:**
175+
170176- ` --db` — (Odoo only) Override the target database name
171177- ` --ignore-hooks` — Skip all hook execution
172178
173179**Examples:**
180+
174181` ` ` bash
175182# With config file
176183deploy update odoo-myproject-staging
@@ -196,6 +203,7 @@ deploy --config /path/to/deploy.yml update odoo-myproject-staging
196203| `post-update-success` / `post-update-fail` | After update | No |
197204
198205**What it does (Odoo):**
206+
1992071. Runs pre-update hooks
2002082. `git pull` in `~/<instance_name>`
2012093. `uv pip install -r requirements.txt`
@@ -212,7 +220,8 @@ deploy [--config FILE] status <instance_name> [ssh_host] [-p PORT]
212220` ` `
213221
214222**Output:**
215- ```
223+
224+ ` ` ` bash
216225Instance: odoo-myproject-staging
217226Remote: git@github.com:org/repo.git
218227Branch: main (abc1234)
0 commit comments