Skip to content

Project

oops-pro-show

Display a summary of the current project.

Shows Odoo version, Docker image release date, available image updates, Python requirements, system packages, git remote and release info. With a GitHub token, also shows the latest Actions workflow run.

Usage:

oops-pro-show [OPTIONS]

Options:

Name Type Description Default
--token text GitHub token to request API, needs actions:read or repo scope. Envvar is also supported: TOKEN, GH_TOKEN, GITHUB_TOKEN. None
--minimal boolean Show minimal output. False
--help boolean Show this message and exit. False

Examples:

Display the full project summary:

oops-pro-show

Include the latest GitHub Actions run:

oops-pro-show --token $GH_TOKEN

oops-pro-check

Validate project configuration and list available Odoo Docker images.

Checks for mandatory project files, verifies the configured Odoo image, and reports warnings and errors. Exits non-zero if errors are found; with --strict, warnings also cause a non-zero exit.

Usage:

oops-pro-check [OPTIONS]

Options:

Name Type Description Default
--strict boolean Treat warnings as errors False
--help boolean Show this message and exit. False

Examples:

Run project checks and report warnings and errors:

oops-pro-check

Exit non-zero on warnings as well:

oops-pro-check --strict

oops-pro-update

Update odoo_version.txt to the latest available Docker image.

Queries the image registry for newer releases of the currently configured Odoo version and prompts the user to select one. With --force, picks the latest image automatically and commits the change.

Usage:

oops-pro-update [OPTIONS]

Options:

Name Type Description Default
--force boolean Don't ask for confirmation False
--help boolean Show this message and exit. False

Examples:

Interactively select a new Odoo image:

oops-pro-update

Pick the latest image automatically without prompting:

oops-pro-update --force

oops-pro-exclude

Add symlinked addons to the pre-commit exclusion file.

Writes the list of symlinked addon paths to the pre-commit exclusion file so that pre-commit hooks skip third-party addons. The file is committed unless --no-commit is passed.

Usage:

oops-pro-exclude [OPTIONS]

Options:

Name Type Description Default
--no-commit boolean Do not commit changes False
--help boolean Show this message and exit. False

Examples:

Write the pre-commit exclusion file and commit:

oops-pro-exclude

Write the file without committing:

oops-pro-exclude --no-commit

oops-pro-sync

Synchronise files from the configured remote repository.

Usage:

oops-pro-sync [OPTIONS]

Options:

Name Type Description Default
--dry-run boolean Show the diff without applying changes. False
--force, -f boolean Apply changes without asking for confirmation. False
--help boolean Show this message and exit. False

Examples:

XXX:

oops-pro-sync
```