Skip to content

Installation

Prerequisites

  • Python >= 3.10
  • Docker with Compose V2 plugin
  • Git

Install via pip

pip install odoofly

Install via pipx (isolated)

pipx install odoofly

Install via Poetry (development)

git clone https://github.com/Alitux/odoofly.git
cd odoofly
poetry install
poetry run odoofly --version

CLI Entrypoints

Command Alias
odoofly of

Both resolve to the same Typer application.

Shell Completion (Tab Autocompletion)

After installation, enable tab completion for your shell:

of --install-completion bash      # Bash
of --install-completion zsh       # Zsh
of --install-completion fish      # Fish

You may need to restart your terminal after running the command.

Odoofly provides autocompletion for:

  • Environment names — all env, db, repo, staging, backup commands
  • Database namesdb shell, db rm, db cpn, env backup new, env install, env uninstall, env update
  • Backup filenamesenv backup rm
  • Repository URLsrepo rm

Note: Database name completion requires the environment container to be running.