odoo-18

Imported from David-Li0406/meta-skill-evloving (skill-flow/data/skills-refined-autoskill-36k/skillsmp/odoo-18/AGENTS.md). Install upstream with npx skills add David-Li0406/meta-skill-evloving --skill odoo-18. Copyright stays with the author.

Odoo 18 Documentation - AI Agents Setup

This guide explains how to use the Odoo 18 documentation with different AI coding assistants (Cursor, Claude Code, OpenCode, GitHub Copilot, etc.).

Quick Start

Using Remote Rules (Cursor - Recommended)

1. Configure once in Cursor:

   • Settings → Rules → Add Remote Rule
   • Source: Git Repository
   • URL: git@github.com:unclecatvn/agent-skills.git
   • Branch: odoo/18.0 (hoặc main)

2. Done! Rules auto-apply to ALL your projects

Local Copy (Alternative)

1. Clone the repository:

   git clone git@github.com:unclecatvn/agent-skills.git
   cd agent-skills

2. Copy to your project:

cp -r skills/odoo/18.0 /your-project/docs/skills/odoo/

3. **For Claude Code, add symlink:**
```bash
ln -s docs/skills/odoo/18.0/CLAUDE.md ./CLAUDE.md

Documentation Structure

docs/skills/odoo/18.0/
├── SKILL.md                       # Master reference (all agents)
├── CLAUDE.md                      # Claude Code specific
├── AGENTS.md                      # THIS FILE - setup guide
├── odoo-18-model-guide.md         # ORM, CRUD, search, domain
├── odoo-18-field-guide.md         # Field types, parameters
├── odoo-18-decorator-guide.md      # @api decorators
├── odoo-18-view-guide.md          # XML views, actions, menus
├── odoo-18-performance-guide.md    # N+1 prevention, optimization
├── odoo-18-transaction-guide.md   # Savepoints, UniqueViolation, commit/rollback
├── odoo-18-controller-guide.md     # HTTP, routing, controllers
├── odoo-18-owl-guide.md           # OWL components, hooks, services
└── odoo-18-development-guide.md    # Manifest, reports, security

Quick Reference for Each File

Repository: git@github.com:unclecatvn/agent-skills.git Branch: odoo/18.0 (or main) This documentation is part of the agent-skills repository

Cursor IDE

How Cursor Uses This Documentation

Cursor automatically discovers .mdc files with YAML frontmatter and applies the rules based on the globs pattern.

Setup Options

Option A: Remote Rules (Recommended)

This documentation is already in git@github.com:unclecatvn/agent-skills.git

1. Configure Cursor Remote Rule:
   • Go to Settings → Rules → Add Remote Rule
   • Source: Git Repository
   • URL: git@github.com:unclecatvn/agent-skills.git
   • Branch: odoo/18.0 (hoặc main)

• Optional: Subfolder: skills/odoo/18.0/ (nếu có nhiều skills)

2. Done! Cursor auto-applies rules to ALL your projects

Benefits:

• ✅ One central source of truth for all AI agent skills
• ✅ Update once, all projects受益
• ✅ No file pollution in projects
• ✅ Shared across teams

Option B: Local Copy

Copy documentation to project:

cp -r docs/skills/odoo/18.0 /your-project/docs/skills/odoo/

Use when:

• Working offline frequently
• Want project-specific overrides

.mdc Format

---
description: What this guide covers
globs: "**/*.py"
alwaysApply: true
---

# Content here

Key .mdc Files for Cursor

Frontmatter Fields Used by Cursor

Claude Code (claude.ai/code)

How Claude Code Uses This Documentation

Claude Code reads CLAUDE.md and SKILL.md to understand project-specific patterns and best practices.

Setup

1. Place CLAUDE.md in project root (or symlink):

ln -s docs/skills/odoo/18.0/CLAUDE.md ./CLAUDE.md

2. **Or copy**:
```bash
cp docs/skills/odoo/18.0/CLAUDE.md ./CLAUDE.md

What Claude Code Reads

OpenCode

How OpenCode Uses This Documentation

OpenCode reads markdown files with YAML frontmatter, using the description and globs fields to determine when to apply each guide.

Setup

1. Copy documentation to your project
2. No additional configuration - OpenCode auto-discovers markdown files with frontmatter

Frontmatter Format

---
name: odoo-18-model
description: Complete reference for Odoo 18 ORM...
globs: "**/models/**/*.py"
topics:
  - Recordset basics
  - Search methods
when_to_use:
  - Writing ORM queries
---

GitHub Copilot

How Copilot Uses This Documentation

Copilot doesn't have built-in documentation reading, but having clear code examples in markdown files can improve suggestions.

Setup

1. Keep documentation in docs/ folder
2. Reference in comments when needed:

See docs/skills/odoo/18.0/odoo-18-model-guide.md for ORM patterns

---

## Other AI Agents

### Windsurf

Similar to Cursor - uses `.mdc` files with YAML frontmatter.

### Continue

Reads project documentation. Place `CLAUDE.md` or `SKILL.md` in project root.

### Tabnine

Limited documentation reading. Use code comments to reference guides.

### Aider

Reads markdown files. Can use `CLAUDE.md` or add to prompt.

### Codeium

Limited documentation reading. Use inline code comments.

---

## Installation in Your Project

### Option 1: Remote Rules (Recommended for Cursor)

**No files needed in project** - Configure once in Cursor:

1. Already configured in repo: `git@github.com:unclecatvn/agent-skills.git`
2. Cursor → Settings → Rules → Add Remote Rule
3. URL: `git@github.com:unclecatvn/agent-skills.git`
4. Branch: `odoo/18.0` (hoặc `main`)

### Option 2: Local Copy

For **Cursor** only:
```bash
cp docs/skills/odoo/18.0/SKILL.md /your-project/

For Claude Code only:

cp docs/skills/odoo/18.0/CLAUDE.md /your-project/

For Both:

cp docs/skills/odoo/18.0/SKILL.md /your-project/
cp docs/skills/odoo/18.0/CLAUDE.md /your-project/

Option 3: Git Submodule (Alternative)

# In your project
git submodule add git@github.com:unclecatvn/agent-skills.git docs/skills/odoo/18.0

Frontmatter Reference

All guide files use this YAML frontmatter format:

---
name: odoo-18-[topic]
description: [Brief description of what this guide covers]
globs: [file pattern to apply this guide to]
topics:
  - [Topic 1]
  - [Topic 2]
when_to_use:
  - [Use case 1]
  - [Use case 2]
---

Common glob Patterns

File Priority (When Multiple Guides Match)

When a file matches multiple guides (e.g., models/my_model.py), agents typically use:

1. Most specific globs win (**/models/**/*.py > **/*.{py,xml})
2. Alphabetical order as tiebreaker

Example Priority for models/sale_order.py

Customizing for Your Project

Adding Project-Specific Rules

Create a .mdc file in your project root:

---
description: Project-specific Odoo 18 rules and conventions
globs: "**/*.{py,xml}"
---

# Project Specific Rules

## Naming Convention

- Model names: `project.module.name`
- XML IDs: `project_module_view_...`
- Python files: lowercase with underscores

## Custom Patterns

# Always include company_id in domain
domain = [('company_id', '=', self.env.company.id)] + domain

Overriding Default Rules

To override a specific rule, create a new .mdc with a more specific globs pattern:

---
description: Override for specific module
globs: "**/models/specific_model.py"
---

# This overrides general rules for specific_model.py only

Troubleshooting

Cursor not applying rules

1. Check file extension is .mdc
2. Verify YAML frontmatter is valid (use a YAML validator)
3. Check globs pattern matches your files
4. Try reopening the project

Claude Code not seeing documentation

1. Ensure CLAUDE.md is in project root
2. Check file is readable (not binary)
3. Try referencing explicitly: "See CLAUDE.md for..."

Conflicting rules from multiple guides

1. Check globs specificity
2. More specific patterns take precedence
3. Rename files to control alphabetical order if needed

Version Compatibility

Key Breaking Changes (Odoo 17 → 18)

• <tree> → <list> for list views
• unlink() override → @api.ondelete()
• group_operator= → aggregator=
• cr.execute() → SQL class

Contributing

To improve this documentation:

1. Edit the relevant guide file
2. Update frontmatter if adding new topics
3. Test with your AI agent
4. Submit pull request

License

MIT License - See individual files for details.