Welcome to oduit’s documentation!

oduit is an Odoo CLI and Python utility layer focused on two things:

• running common Odoo workflows with structured results

• understanding addons through manifest, dependency, and series introspection

Highlights

• oduit doctor for setup diagnostics

• structured JSON output for automation and CI

• addon intelligence commands such as list-addons, list-depends, install-order, explain-install-order, and impact-of-update

• split addon technical documentation workflows with deterministic evidence and LLM/human report files

• oduit agent as the primary automation surface for coding agents, including discovery, location, and verification flows such as get-model-fields, locate-model, validate-addon-change, and test-summary

• Python APIs for operations, addon analysis, typed planning models, and safe read-only queries

Quick Start

oduit --env dev doctor
oduit --env dev version
oduit --env dev list-addons
oduit --env dev install-order sale,purchase
oduit --env dev explain-install-order sale

Installation

pip install oduit

Contents

Contents:

• Installation
  • Requirements
  • Install from PyPI
  • Install from Source
  • Development Installation
  • Dependencies
• Quick Start Guide
  • Migrating from an existing odoo.conf
  • Preferred Configuration
  • CLI Workflows
  • Python API
  • Next Steps
• Addon technical documentation
  • Purpose
  • Files
  • Recommended workflow
  • Allowed addon directories
  • Freshness and review
  • Legacy workflow
• Migrating from odoo.conf
  • One-command import
  • Inspect the generated config
  • Validate the environment
  • Use the migrated config
  • Do not commit secrets
  • Suggested no-pytest validation commands
• Using oduit from a coding agent
  • Command Families
  • Recommended Command Sequence
  • Mutation Policy
  • Payload Expectations
  • Compatibility Policy
  • Payload Stability Tiers
  • Command Stability Tiers
  • Safety Levels
  • Published Schemas
  • Failure Handling
  • Example
• Agent command inventory
• Agent Output Audit
  • Prerequisites
  • Phase 1 — Discovery run (default matrix)
  • Phase 2 — Explicit matrix run
  • Phase 3 — Mutating commands
  • Reading the report
  • CLI reference
  • Example matrix file
  • Output budget targets
• Which Interface?
  • Coding Agents
• Command Line Interface
  • Installation
  • Configuration
  • Import an existing Odoo config
  • Basic Usage
  • Commands
  • Trusted Execution and Inspection
  • Output Formats
  • Agent Commands
  • Common Workflows
  • Error Handling
  • API Reference
  • See Also
• CLI command inventory
• Configuration
  • Recommended Format
  • Recommended setup for existing Odoo projects
  • Supported Locations
  • Compatibility Notes
  • Canonical Normalized Shape
  • Canonical Normalized Shape
  • Operation sets are not environment configuration
  • Important Keys
  • Translation-specific config caution
  • Documentation workflow settings
  • Python Usage
  • Import Existing Odoo Configuration
  • Diagnostics
• API Reference
  • Core Modules
  • Command Line Interface
  • Utilities
  • Complete API
• Examples
  • Core Workflows
  • Addon and Manifest Workflows
  • Trusted Code Execution
  • Inspection and Database Workflows
  • Demo Mode
  • Configuration Examples
• Changelog
  • Unreleased
  • 0.4.6
  • 0.4.5
  • 0.4.4
  • 0.4.3
  • 0.4.2
  • 0.4.1
  • 0.4.0
  • 0.3.0
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.7
  • 0.1.6
  • 0.1.5
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0

Indices and tables

• Index

• Module Index

• Search Page