Cleo - Odoo CLI Tools

A comprehensive command-line toolkit for Odoo developers to streamline daily operations.

Features

• Module Development: Scaffold modules, models, views, controllers, migrations
• Repository Management: Clone, update, and manage git repositories with shortcuts
• Docker Support: Complete docker development environment
• Deployment: Deploy modules to development/staging instances via SSH
• Version Detection: Auto-detect Odoo version from environment or file
• Generic & Portable: No company-specific code, works for any developer

Installation

cd cleo
./install.sh

Or manually:

pipx install .

Uninstall

./uninstall.sh

Quick Start

# Set Odoo version (optional)
export ODOO_VERSION="17.0"

# See all commands
cleo --help

# Scaffold a new module
cleo scaffold module my_module --depends base,sale --models --views

# Create migration files
cleo scaffold migration my_module --name add_new_field

# Clone repository with GitHub shortcut
cleo repo add gh:user/repo

# Docker development
cleo docker create --modules base,sale,website
cleo docker up
cleo docker logs --follow

# Deploy modules
cleo odoo dev deploy my_module --user dev --server dev.example.com
cleo odoo dev deploy all --user dev --server dev.example.com

Commands Overview

Scaffold

cleo scaffold module <name>       # Create new Odoo module
cleo scaffold model <module>      # Add model to module
cleo scaffold view <module>       # Add views to module
cleo scaffold controller <module> # Add controller to module
cleo scaffold migration <module>  # Create migration files

Repository

cleo repo add <url>          # Clone repository (supports gh:, gl: shortcuts)
cleo repo status [path]      # Check git status
cleo repo diff [path]        # Compare modules between branches
cleo repo remove <path>      # Remove repository (if clean)

Docker

cleo docker create           # Initialize Docker environment
cleo docker up               # Start containers
cleo docker down             # Stop containers
cleo docker init             # Initialize Odoo database
cleo docker logs             # View container logs
cleo docker clean            # Clean environment
cleo docker info             # Show environment info

Odoo Dev

cleo odoo dev deploy <module>  # Deploy module(s) to server
cleo odoo dev deploy all       # Deploy all modules
cleo odoo dev logs             # View live server logs

Odoo Version

cleo odoo version show       # Display detected Odoo version

Configuration

Odoo Version

Set via environment variable or .odooversion file:

export ODOO_VERSION="17.0"
# OR
echo "17.0" > .odooversion

Docker

Docker workspaces are stored in ~/.odoo-docker/<repo>/<branch>

Requirements

• Python 3.12+
• Git
• Docker (for docker commands)
• SSH access (for deployment commands)