| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Lines of code | 454 |
| Technical Name |
ai_agent_code_search_tool |
| License | OPL-1 |
| Website | https://codemarchant.com |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Lines of code | 454 |
| Technical Name |
ai_agent_code_search_tool |
| License | OPL-1 |
| Website | https://codemarchant.com |
AI Code Search Tools
Explore Odoo Source Code with AI-Powered Search
Overview
Give your Odoo AI Agent the power to search and read addon source code — like having Claude Code built into Odoo.
This module extends Odoo 19's standard AI Agent functionality with two powerful code exploration tools. Search across all installed addons using regex patterns, filter by module or file type, and read source files with line numbers and pagination.
Whether you're debugging an issue, learning how a feature works, or exploring implementation patterns — simply ask your AI agent and let it find the relevant code for you.
Includes a pre-configured "Code Analysis" topic with both tools ready to use, plus high-performance ripgrep integration with Python fallback for universal compatibility.
How It Works
Add Topic to Agent
Add the "Code Analysis" topic to your AI Agent configuration
Ask a Question
Ask about implementations, patterns, or specific code in natural language
AI Searches Code
The agent searches across all addons using regex and reads relevant files
Get Code Insights
Receive explanations with code snippets, file paths, and line numbers
Pre-Configured Code Analysis Topic
A new "Code Analysis" topic is automatically available after installation
Topics list with the new Code Analysis topic highlighted
Topic Configuration
The topic includes optimized instructions and both code exploration tools
Code Analysis topic form view showing instructions and linked tools
Topic Instructions
- Concise workflow guidance for the AI agent
- Discovery, examination, and response steps
- Pagination handling for large result sets
- Error handling suggestions
Included Tools
- AI: Search Addon Code — regex search across addons
- AI: Read Addon File — read source with line numbers
- Both tools include detailed AI schemas
- Ready to use out of the box
Search Addon Code Tool
Powerful regex search with multiple output modes and filtering options
Server action form showing AI tool schema and description
Search Parameters
- pattern: Regex pattern to search for
- module: Limit to specific addon
- file_pattern: Filter by file type (*.py, *.xml)
- case_sensitive: Toggle case sensitivity
Output Modes
- files_with_matches: Fast file path discovery
- content: See matching lines with context
- count: Match counts grouped by module
- Pagination with offset/limit for large results
Read Addon File Tool
Read source code with line numbers and pagination support
Server action form showing AI tool schema and description
Read Parameters
- file_path: Relative path from search results
- offset: Start line (1-indexed)
- limit: Number of lines to read
Security Features
- Path validation prevents directory traversal
- Whitelist of allowed file extensions
- Read-only access to addon paths only
Easy Agent Configuration
Simply add the Code Analysis topic to your AI Agent
AI Agent configuration with the Code Analysis topic added
Configuration Steps
- Open your AI Agent configuration (or create a new one)
- In the Topics section, add "Code Analysis"
- Save the agent — the code search tools are now available
- Start a conversation and ask about Odoo source code
Natural Language Code Exploration
Ask questions about Odoo code in plain English
Ask AI chat with code search questions and detailed responses
"How does the sale order confirmation work?"
"Find all models that inherit from product.template"
"Show me the create method in stock.move"
"What fields does res.partner have?"
"Find XML views that use the kanban view type"
"How is the invoice PDF generated?"
Key Features
High Performance
Uses ripgrep for blazing-fast searches when available. Automatic fallback to Python for universal compatibility.
Regex Powered
Full regex support for precise pattern matching. Find class definitions, method signatures, field declarations, and more.
Flexible Filtering
Filter by module, file type, or glob pattern. Search only Python, XML, JavaScript, or any combination.
Line Numbers
Results include line numbers for easy reference. Jump to exact locations in the source code.
Pagination Support
Handle large result sets with offset and limit. Read files in chunks for memory efficiency.
Secure by Design
Read-only access with path validation. File extension whitelist prevents access to sensitive files.
Use Cases
Debugging
Quickly find where a field is defined, how a method is implemented, or trace through the call stack of a complex operation.
Learning Odoo
Explore how core modules implement features. Learn patterns and best practices from the source.
Extending Modules
Find the right methods to override or extend. Understand inheritance chains and dependencies.
Code Review
Search for patterns, anti-patterns, or specific implementations across your entire addon ecosystem.
Documentation
Ask the AI to explain complex code sections. Get contextual documentation generated from source.
Architecture Analysis
Explore model relationships, understand module dependencies, and map out system architecture.
Supported File Types
Search and read across all common Odoo development file types
.py
Python
.xml
Views & Data
.js / .ts
JavaScript
.css / .scss
Stylesheets
.csv
Data Files
.json
Configuration
.md / .rst
Documentation
.html / .txt
Templates
Technical Details
Extends ai.agent
Adds code_search and code_read tool methods to the AI Agent model
Ripgrep Integration
Uses ripgrep (rg) for high-performance search with Python fallback
Path Security
Validates paths to prevent directory traversal and unauthorized access
Configurable Limits
Max 500 search results and 500 lines per read for optimal performance
Requirements
Dependencies
- ai — Odoo AI module (Enterprise)
Compatibility
- Odoo 19 Enterprise
- Optional: ripgrep (rg) for best performance
Important Notice
Code Exposure: This module provides read access to the source code of all installed Odoo addons on your server, including proprietary, enterprise, and third-party modules. Any user with access to an AI Agent configured with this topic can view this source code through the AI interface.
Compliance: Before installing, ensure that exposing addon source code complies with your organization's security policies, licensing agreements, and any applicable confidentiality obligations.
Support
We're here to help you explore Odoo code with AI.
Email Support
support@codemarchant.com
Website
codemarchant.com
Explore Odoo Code Like Never Before
Install the AI Code Search Tools module and give your AI agent the power to navigate your codebase.
AI Code Search Tools
Overview
This module extends Odoo's AI Agent with tools to search and read addon source code.
Features
- Code Search: Regex-powered search across all installed addons
- Code Read: Read source files with line numbers and pagination
- Pre-configured Topic: "Code Analysis" topic ready to use
- High Performance: Uses ripgrep when available, Python fallback otherwise
- Secure: Path validation, file extension whitelist, read-only access
Installation
Install the module from the Odoo Apps menu. No additional configuration required.
Optional: Ripgrep Installation
For best search performance, install ripgrep:
Ubuntu/Debian:
sudo apt install ripgrep
macOS (Homebrew):
brew install ripgrep
Windows (Chocolatey):
choco install ripgrep
Windows (Scoop):
scoop install ripgrep
If ripgrep is not installed, the module falls back to Python-based search.
Usage
- Add the "Code Analysis" topic to your AI Agent
- Start a conversation with the agent
- Ask questions about Odoo source code in natural language
Example queries:
- "How does the sale order confirmation work?"
- "Find all models that inherit from product.template"
- "Show me the create method in stock.move"
Limitations
- Read-only access to installed addon paths
- Supported file types: .py, .xml, .js, .ts, .css, .scss, .csv, .txt, .md, .rst, .html, .json
- Maximum 500 search results per query
- Maximum 500 lines per file read
Important Notice
Code Exposure: This module provides read access to the source code of all installed Odoo addons on your server, including proprietary, enterprise, and third-party modules. Any user with access to an AI Agent configured with this topic can view this source code through the AI interface.
Compliance: Before installing, ensure that exposing addon source code complies with your organization's security policies, licensing agreements, and any applicable confidentiality obligations.
Changelog
19.0.1.0.0
- Initial release
Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module