gOdoo is a Python CLI for teams developing and operating Odoo projects. It manages manifest-selected sources, prepares databases with their matching filestores, and runs Odoo against that prepared state.

Git, workspace commands, and editor configuration run on the host. Runtime commands run in the selected Python environment. Your downstream project owns Docker, system packages, runtime users, service ordering, and debugger startup.

What you can do

Runtime commands require Odoo 16 or newer. CI checks gOdoo on Python 3.11 and 3.12; the example Odoo 19 stack uses PostgreSQL 18 with pgvector.

Quick start

Run the example development stack

Install Git, uv, Python 3.11 or newer, Make, Docker, and Docker Compose. Then clone the development branch and install the host tools:

git clone https://github.com/OpenJKSoftware/gOdoo.git
cd gOdoo
make setup
cp .env.sample .env

Edit .env before continuing:

• Set GODOO_SOURCES_ROOT to an absolute directory outside this checkout, accessible to Docker.
• Set the database credentials and target values for your environment.

Review odoo_manifest.yml to select Odoo and any third-party sources, then run:

make sync       # Synchronize managed source worktrees.
make workspace  # Generate the host editor workspace.
make dev        # Build and start the example Compose stack.

make sync changes managed worktrees and may reset verified worktrees. make workspace generates editor configuration; make dev validates source paths on the host before starting Compose.

The example stack uses Nginx for HTTP and file delivery. See downstream runtime setup for image, networking, restore dataset mounts, and production build configuration.

Use gOdoo in your own project

Install the CLI from the development branch:

uv tool install "git+https://github.com/OpenJKSoftware/gOdoo.git@main"

On Linux, the PostgreSQL Python driver also requires PostgreSQL development headers and a C compiler. Your runtime environment needs the Odoo sources, Python dependencies, PostgreSQL tools, and system packages described in the downstream guide.

Run workspace commands from your project's directory, with its own .env and odoo_manifest.yml. Run runtime commands in the Python environment that contains Odoo; gOdoo uses VIRTUAL_ENV, otherwise the project's .venv. Follow the source workspace guide to configure sources and the editor.

Commands

Commands read the project .env. Explicit CLI values → exported environment → project .env is the configuration precedence. Use godoo --help or godoo <command> --help for the full reference.

Prepare once, then launch

Initialization prepares the database and matching filestore, checks dependencies, and runs selected module updates and hooks. Launch starts the prepared runtime. In Compose, the app should depend on the init service completing successfully.

# Run in a configured runtime environment with other Odoo writers stopped.
godoo runtime init && godoo runtime launch

Use godoo runtime init --if-needed for startup that skips reconciliation when the runtime is already ready. For deployments applying module updates or hooks, use explicit initialization. Inspect state without changing it:

godoo runtime status --json

See the lifecycle guide for dataset selection, demo mode, restore progress, reset baselines, and recovery. Use native migrations and hooks for versioned repairs and recurring environment policy.

Documentation

Migrating from earlier versions

The host workspace and explicit runtime commands replace the former Dev Container workflow. Downstream projects now own their Dockerfile and Compose configuration.

Contributing

Bug reports and focused pull requests are welcome. Open an issue with the gOdoo revision, Odoo version, command, and relevant diagnostics so the behavior can be reproduced.

For development, follow the source checkout steps above. Install the pinned text formatter with npm ci, then open godoo.code-workspace so the repository's editor settings apply. See repository architecture for code ownership and test layout.

Run the host quality checks and repository tests:

make lint
make test

Real Odoo/PostgreSQL integration tests use a prepared runtime environment and the separate make test-odoo-integration target. See runtime lifecycle and downstream setup before running them.

License & acknowledgements

gOdoo is licensed under the GNU Lesser General Public License v3.0.

Made possible by WEMPE Elektronic GmbH.