Odoo

/odoo

Odoo ERP integration. Two ways to work: CLI (fastest for most tasks) and Library (for scripts and automation).

Two Ways to Work with Odoo

CLI — Fastest for Most Tasks

The odoo CLI lets you search, create, update, and delete records without writing any code.

# 1. Verify connection (always do this first)
odoo config check

# 2. Search records
odoo records search res.partner --fields name,email --limit 5

# 3. Create a record
odoo records create res.partner --data '{"name":"Acme Corp"}' --confirm

# 4. Post a note on a record
odoo mail note crm.lead 42 "Called customer" --confirm

Library — For Scripts and Automation

import { createClient } from '@marcfargas/odoo-client';

const client = await createClient();  // reads ODOO_URL, ODOO_DB, ODOO_USER, ODOO_PASSWORD

const partners = await client.searchRead('res.partner', [['is_company', '=', true]], {
  fields: ['name', 'email'],
  limit: 10,
});

await client.mail.postInternalNote('crm.lead', 42, '<p>Called customer.</p>');
await client.modules.isModuleInstalled('sale');

Quick Start

Step 1: Configure Environment

export ODOO_URL=https://mycompany.odoo.com
export ODOO_DB=mycompany
export ODOO_USER=admin
export ODOO_PASSWORD=yourpassword

Step 2: Verify Connection

odoo config check
# ✓ Connected to https://mycompany.odoo.com (db: mycompany)
#   User: Administrator (admin) [id: 2]
#   Installed modules: 143

Step 3: Explore

# Search for records
odoo records search res.partner --fields name,email --limit 10

# Introspect schema
odoo schema fields crm.lead --type many2one

# Check installed modules
odoo modules list --filter installed --search sale

CLI Exit Codes

All odoo CLI commands use these standard exit codes:

Use in scripts:

odoo records get crm.lead 42 || echo "Exit code: $?"

CLI Command Reference

Library API

Service Accessors

Domain-specific helpers are accessed via lazy getters on the client:

Core CRUD (searchRead, create, write, unlink, etc.) stays directly on client.

Safety Model

Prerequisites (Must Read First)

Before any Odoo operation, load these foundational modules:

1. base/connection.md — createClient(), authentication, environment variables
2. base/field-types.md — Odoo type system (read/write asymmetry)
3. base/domains.md — Query filter syntax

Additional Modules

Load as needed by reading base/{name}.md:

Mail & Messaging

Skills for Odoo's mail system. Load by reading mail/{name}.md:

Note: The mail module is part of base Odoo and is typically always installed.

Module-Specific Skills

Skills that require specific Odoo modules to be installed. Before loading, verify the required modules are present.

# CLI: check a module is installed
odoo modules status hr_attendance

// Library: check a module is installed
await client.modules.isModuleInstalled('hr_attendance')

Load by reading the path shown below: