Параметры командной строки

Команда odpm (или python3 …/odpm.py) принимает параметры, которые задают одноразовое поведение: инициализацию, работу с базой, сборку образа, план изменений. Полный список с краткими подсказками на английском: odpm --help.

Ниже — справочник по группам на русском языке. Имена флагов приведены как в программе (латиница).

Инициализация проекта

Параметр	Описание
--init ССЫЛКА	Сделать текущий каталог odpm-проектом. Ссылка: HTTPS, git@…, file:///…
--branch ИМЯ	Вместе с --init: ветка разрабатываемого репозитория
--odoo-version ВЕР	Версия Odoo (например 17.0) в odpm.json
--odoo-git-link ССЫЛКА	Репозиторий платформы вместо официального odoo/odoo
--platform-name ИМЯ	Имя Python-пакета форка (по умолчанию odoo)
--python-version ВЕР	Версия Python в образе
--distro-name ИМЯ	Имя дистрибутива Linux (сейчас debian)
--distro-version ВЕР	Версия дистрибутива (11, 12, …)
--postgres-version ВЕР	Версия PostgreSQL в compose
--requirements-txt ПАКЕТЫ	Пакеты Python через запятую → запись в odpm.json
--secrets-file ПУТЬ	Импорт JSON v1 в .odpm/secrets.json (при --init и на любом запуске). См. локальные секреты.

Пример:

odpm --init git@github.com:org/my_addons.git --branch 17.0 \
  --odoo-version 17.0 --python-version 3.10 --distro-version 12

Импорт секретов при развёртывании:

odpm --init file:///path/to/my_addons \
  --secrets-file /secure/client-secrets.json

# ротация ключей на существующем проекте
odpm --secrets-file ~/new-secrets.json --skip-start

Подготовка окружения и образ

Параметр	Описание
--skip-start	Пересоздать Docker-файлы и compose без запуска контейнеров; при наличии lock — выбор ревизий по файлу фиксации
--update-lock	Записать .odpm/deps.lock.json и завершить работу
--no-git-update	Не трогать git; lock не читается; каталоги должны уже существовать
--build-image	Собрать образ для сценария ci (иначе ошибка)
--image-tag МЕТКА	Имя и тег образа Docker для --build-image
--version	Показать версию odpm

План изменений (пробный прогон)

Показывает, какие шаги подготовки выполнились бы, без изменения git, записи файлов и docker compose up.

odpm plan --skip-start
odpm plan --plan-format json | jq .
odpm plan --plan-show-diff --skip-start

Устаревший синоним: --plan (лучше подкоманда plan).

Параметр	Описание
--plan-format {table,json}	Таблица в журнал или JSON в stdout
--plan-strict	Код возврата 1, если обязательный шаг — изменение
--plan-show-diff	Показать отличия в runtime config, compose, dockerignore
--plan-no-docker	Не опрашивать Docker о состоянии контейнеров

Среди шагов подготовки есть database.drift — сравнение конфигурации PostgreSQL со снимком last_run.json. См. состояние PostgreSQL.

Подкоманда database

Инспекция и восстановление кластера PostgreSQL (не путать с Odoo-базами -d):

odpm database status
odpm database status --format json
odpm database ensure-role

Команда	Описание
database status	Fingerprints, drift, проверка контейнера postgres и роли приложения
database status --format json	То же в JSON
database ensure-role	Создать или обновить роль приложения в запущенном PostgreSQL

Флаг --accept-database-drift=KIND (повторяемый) — принять drift без интерактивного prompt. KIND: data_path, postgres_major, app_role_missing, odpm_scenario, data_dir_empty_changed.

Подробнее: состояние PostgreSQL и drift.

База данных и модули

Параметр	Описание
-d ИМЯ_БД	Имя базы; при отсутствии — создание по db_creation_data
-i	Установить модули из init_modules
-u	Обновить модули из update_modules
-t, --test	Запустить тесты модулей; нужны -d и обычно -i или -u
--screencasts	С -t: сохранять видео при ошибках туров
--odoo-bin АРГУМЕНТЫ…	Передать аргументы исполняемому файлу Odoo, напр. --stop-after-init

odpm -d test_db -i -u
odpm -d test_db -i --odoo-bin --stop-after-init

Дата ночной сборки платформы

Параметр	Описание
--odoo-build-date ДАТА	ГГГГММДД или ГГГГ-ММ-ДД; перекрывает odoo_build_date в json

Обслуживание базы

Параметр	Описание
--get-dbs-list	Список баз
--db-backup [АРХИВ]	Резервная копия базы -d в BACKUP_DIR
--db-restore АРХИВ	Восстановить архив в базу -d
--db-drop	Удалить Odoo-базу -d; с -i/-u — пересоздать и установить модули. На legacy-кластере с чужим PostgreSQL-owner odpm выполняет прямой DROP DATABASE

Переводы и администратор

Параметр	Описание
--translate ЯЗЫК	Обновить переводы (напр. ru_RU)
--export-po-files ЯЗЫК	Экспорт pot/po для модулей из update_modules
--set-admin-pass	Логин/пароль admin из db_default_admin_*; нужен -d

Прочие инструменты разработчика

Параметр	Описание
--start-precommit	Запустить pre-commit в разрабатываемом проекте в контейнере
--sql-execute	Выполнить SQL из sql_queries; нужен -d

Подкоманда scaffold

Создание каркаса нового модуля (без других флагов odpm):

odpm scaffold имя_модуля
odpm scaffold имя_модуля -t /путь/к/шаблонам

Параметр	Описание
scaffold ИМЯ	Генерация модуля по шаблонам Jinja2
-t, --scaffold_template_name	Каталог своих шаблонов

Фиксация версий git: deps.lock.json.