@bergetai/odoo-cli 0.12.6 → 0.12.7

package/README.md

@@ -46,6 +46,8 @@ odoo models fields res.partner --filter "^email" --json
 odoo models fields crm.lead --custom              # only x_* custom fields
 odoo models read res.partner --ids 51,52 --fields name,city
 odoo models read crm.lead --search "microsoft" --json  # ilike on name (max 100)
+odoo models search mail.activity --domain '[["user_id","=",39],["date_deadline","<=","2026-09-25"]]' --json
+odoo models search mail.activity --filter user_id=39 --fields res_id,summary,date_deadline --json
 
 # List and inspect records
 odoo crm leads list --open --limit 20
@@ -184,7 +186,7 @@ Note: `odoo --version` prints the CLI's own version; `odoo version` queries the
 - Read-only Helpdesk surface (`helpdesk tickets list/show`) — `--open`/`--closed` via stage `fold`, strict team-scoped stage resolution, module-not-installed error (exit 4)
 - Read-only Project surface (`project list/show`) — `--user` (project manager) and `--tag` filters, archived projects excluded by default, module-not-installed error (exit 4)
 - Read-only Project task surface (`project tasks list/show`) — `--project` (required on list, resolved by name or id), project-scoped `--stage`, `--assignee` (many2many `user_ids`), `--tag`, `--priority` (0/Low, 1/High), `--open`/`--closed` via the task's `is_closed` flag, `--domain`/`--filter`, table/JSON output with `search_count` envelope, module-not-installed error (exit 4)
-- Generic model surface (`models fields/read`) — introspect and read any model exposed through `execute_kw`: `fields` lists `fields_get` metadata (type, label, selection, relation, required, store) with `--filter <regex>` (case-insensitive on field name or label) and `--custom` (only `x_*` fields); `read` fetches up to 100 records by `--ids 1,2,3` or a name ilike `--search`, with `--fields a,b,c` (default: name). Unknown models/fields use the standard error taxonomy
+- Generic model surface (`models fields/read/search`) — introspect, read and search any model exposed through `execute_kw`: `fields` lists `fields_get` metadata (type, label, selection, relation, required, store) with `--filter <regex>` (case-insensitive on field name or label) and `--custom` (only `x_*` fields); `read` fetches up to 100 records by `--ids 1,2,3` or a name ilike `--search`, with `--fields a,b,c` (default: name); `search` runs an arbitrary domain via `--domain <json>` (or repeatable `--filter f=v`, mutually exclusive) with `--fields` (default: id[,name]), `--limit`/`--offset`/`--order`, and `--include-archived` (runs with `active_test: false`; eager-fetches rows other list engines hide by default). Unknown models/fields use the standard error taxonomy
 - Documents surface (`documents`) — `tree` (hierarchical folder listing with `--count`/`--depth`/`--folder`), `records list/show` (folders excluded by default, `--type folder|binary|url|all`, `--folder`/`--owner`/`--partner`/`--tag`), `folders list`, `records create` (folder via `--folder-type folder`, link via `--link <url>`), `records update` (move via `--folder`), `records delete`, `upload` (local file → base64 `datas`, MIME guessed from extension, `--dry-run` previews without sending bytes), and `records download <id>` (binary document → local file, `--out <path>`/`--force`, `--out -` streams to stdout). Everywhere a `--folder` is accepted, folders resolve by name, numeric id, or nested `'Parent > Child'` path (segments resolved within their parent, which disambiguates repeated folder names). Folders are `documents.document` rows with `type='folder'`; the hierarchy is `folder_id`. Module-not-installed error (exit 4)
 - Writes (`create`, `update`, `delete`) — single-call atomic batch `write`, client-side no-op diffing, delete convergence with `skipped` ids, post-failure "record may have been created" hint on `create`
 - `--dry-run` for all mutations — full validation, resolution, and before/after diffs without mutating

package/dist/cli.js

@@ -16,7 +16,7 @@ import { signTemplatesCreateFromDocumentCommand, signTemplatesListCommand, signT
 import { invoicesPrecedentCommand, linesAddCommand, linesUpdateCommand, ordersCreateCommand, ordersListCommand, ordersReadCommand, ordersUpdateCommand, pdfCommand, plansListCommand, plansPricingCreateCommand, plansPricingListCommand, plansPricingUpdateCommand, } from "./commands/sales.js";
 import { messagesDeleteCommand, messagesListCommand, messagesScrubCommand, messagesShowCommand, } from "./commands/messages.js";
 import { contactsDeleteCommand, contactsListCommand, contactsShowCommand, listsListCommand, listsShowCommand, tracesDeleteCommand, tracesListCommand, tracesShowCommand, } from "./commands/marketing.js";
-import { modelsFieldsCommand, modelsReadCommand, } from "./commands/models.js";
+import { modelsFieldsCommand, modelsReadCommand, modelsSearchCommand, } from "./commands/models.js";
 import { footprintCommand, } from "./commands/footprint.js";
 import { CliError } from "./errors.js";
 import { applyGlobalOptions, enforceTransportSecurity, DEFAULT_TIMEOUT, } from "./global-options.js";
@@ -1373,6 +1373,25 @@ Examples:
         .action(async (model, opts) => {
         await run((g) => modelsReadCommand(model, opts, g), program);
     });
+    models
+        .command("search")
+        .description("search records by domain (search_read; use --fields, --limit, --order)")
+        .argument("<model>", "model technical name, e.g. mail.activity")
+        .option("--domain <json>", 'Odoo domain as a JSON array, e.g. [["date_deadline","<=","2026-01-31"]]')
+        .option("--filter <field=value>", "equality filter on raw values (repeatable); many2one values must be numeric ids", collect, [])
+        .option("--fields <a,b,c>", "fields to fetch (default: id[,name])")
+        .option("--limit <n>", "max records (default: 50)", "50")
+        .option("--offset <n>", "skip the first n records", "0")
+        .option("--order <order>", 'sort order, e.g. "date_deadline asc"')
+        .option("--include-archived", "match archived records too (runs with active_test: false)")
+        .addHelpText("after", `
+Examples:
+  $ odoo models search mail.activity --domain '[["user_id","=",39],["date_deadline","<=","2026-09-25"]]' --json
+  $ odoo models search mail.activity --filter user_id=39 --fields res_id,summary,date_deadline --json
+  $ odoo models search crm.lead --domain '[["team_id","=",2]]' --order "create_date desc" --limit 20 --json`)
+        .action(async (model, opts) => {
+        await run((g) => modelsSearchCommand(model, opts, g), program);
+    });
     return program;
 }
 async function run(fn, program) {

package/dist/commands/models.js

@@ -1,9 +1,16 @@
+import { buildFilterClauses, parseDomain } from "../filter.js";
 import { notFoundError, usageError } from "../errors.js";
 import { fieldsGet, ModelFields } from "../model.js";
 import { colorEnabled, printJson } from "../output.js";
 import { authenticatedClient } from "../resource.js";
 import { formatTable, humanCell } from "../table.js";
 const MAX_READ = 100;
+function parseCount(raw, flag) {
+    if (!/^\d+$/.test(raw)) {
+        throw usageError(`invalid ${flag} value ${JSON.stringify(raw)}`, "expected a non-negative integer");
+    }
+    return Number(raw);
+}
 function parseFieldList(raw) {
     const fields = raw
         .split(",")
@@ -125,3 +132,54 @@ export async function modelsReadCommand(model, opts, globals) {
     const rows = records.map((r) => fields.map((f) => humanCell(r[f])));
     process.stdout.write(formatTable(headers, rows, colorEnabled(globals.noColor)) + "\n");
 }
+/**
+ * `models search <model>` — generic domain search over any model reachable
+ * through execute_kw. The read-side counterpart to `models read` when the
+ * name-ilike search is not enough: arbitrary domains via JSON --domain, or
+ * another model's filter surface via repeatable --filter f=v (id equality on
+ * many2one fields). Sqlite-style paging via --limit/--offset; ordering via
+ * --order. --include-archived disables active_test so archived rows are
+ * matched; on models without an `active` field it is a no-op.
+ */
+export async function modelsSearchCommand(model, opts, globals) {
+    if (opts.domain !== undefined && opts.filter && opts.filter.length > 0) {
+        throw usageError("--domain and --filter are mutually exclusive", "pick one filtering form");
+    }
+    const limit = parseCount(opts.limit, "--limit");
+    const offset = parseCount(opts.offset, "--offset");
+    const client = await authenticatedClient(globals);
+    const meta = await ModelFields.load(client, model);
+    const domain = [];
+    if (opts.domain !== undefined) {
+        domain.push(...parseDomain(opts.domain));
+    }
+    else if (opts.filter && opts.filter.length > 0) {
+        domain.push(...buildFilterClauses(opts.filter, meta, {}, `run \`odoo models fields ${model}\` to list available fields`));
+    }
+    const defaultFields = meta.get("name") ? ["id", "name"] : ["id"];
+    const fields = opts.fields !== undefined ? parseFieldList(opts.fields) : defaultFields;
+    for (const field of fields) {
+        if (field !== "id" && !meta.get(field)) {
+            throw usageError(`unknown field ${JSON.stringify(field)} on ${model}`, "run `odoo models fields <model>` to list available fields");
+        }
+    }
+    const context = opts.includeArchived
+        ? { active_test: false }
+        : undefined;
+    const kwargs = { fields, limit, offset, order: opts.order ?? "id asc" };
+    if (context)
+        kwargs.context = context;
+    const [records, count] = await Promise.all([
+        client.executeKw(model, "search_read", [domain], kwargs),
+        client.executeKw(model, "search_count", [domain], {
+            ...(context ? { context } : {}),
+        }),
+    ]);
+    if (globals.json) {
+        printJson({ model, records, count, limit, offset });
+        return;
+    }
+    const headers = fields.map((f) => meta.get(f)?.string ?? f);
+    const rows = records.map((r) => fields.map((f) => humanCell(r[f])));
+    process.stdout.write(formatTable(headers, rows, colorEnabled(globals.noColor)) + "\n");
+}

package/dist/filter.js

@@ -33,7 +33,7 @@ export function parseFilterScalar(raw) {
  * many2one fields only accept numeric ids — a non-numeric value is a usage
  * error pointing at the resolution flags, never a silently empty result.
  */
-export function buildFilterClauses(filters, fields, resolutionHints) {
+export function buildFilterClauses(filters, fields, resolutionHints, unknownFieldHint) {
     const clauses = [];
     for (const filter of filters) {
         const eq = filter.indexOf("=");
@@ -44,7 +44,8 @@ export function buildFilterClauses(filters, fields, resolutionHints) {
         const rawValue = filter.slice(eq + 1);
         const meta = fields.get(field);
         if (!meta) {
-            throw usageError(`unknown field ${JSON.stringify(field)} in --filter`, "check the field name with `odoo crm leads show <id> --all-fields`");
+            throw usageError(`unknown field ${JSON.stringify(field)} in --filter`, unknownFieldHint ??
+                "check the field name with `odoo crm leads show <id> --all-fields`");
         }
         const value = parseFilterScalar(rawValue);
         if (meta.type === "many2one" &&

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bergetai/odoo-cli",
-  "version": "0.12.6",
+  "version": "0.12.7",
   "description": "Agent-first CLI for the Odoo External API",
   "publishConfig": {
     "access": "public"