/odoo

Odoo ERP integration via @marcfargas/odoo-client. Connect, query, and automate.

Quick Start

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

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

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

// Chatter — via client.mail service accessor
await client.mail.postInternalNote('crm.lead', 42, '<p>Called customer.</p>');
await client.mail.postOpenMessage('res.partner', 7, 'Order shipped.');

// Module management — via client.modules accessor
if (await client.modules.isModuleInstalled('sale')) { /* ... */ }

Service Accessors

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

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

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.

Version-Specific Notes

Breaking changes between Odoo versions are documented in CHANGES_V{XX}.md:

Module-Specific Skills

Skills that require specific Odoo modules to be installed. Before loading, verify the required modules are present using client.modules.isModuleInstalled().

Load by reading the path shown below:

Skill Generation Workflow

1. •Read base/introspection.md
2. •Introspect target model schema
3. •Create skills/{model-action}.md following the format in base/skill-generation.md
4. •Update this SKILL.md to reference the new skill