Documentation

Getting Started

ERPeek helps you understand, search, and analyze Odoo codebases using AI-powered retrieval-augmented generation (RAG). Sign up for an account, create your first project, and start asking questions about any Odoo version, community or enterprise.

Creating a Project

Navigate to your dashboard and click "New Project." Choose an Odoo version (e.g., 17.0, 16.0), select the distribution (Community or Enterprise), and optionally connect your GitHub repositories for custom addons. ERPeek will clone and index the codebase so you can query it with natural language.

1. 1Go to Dashboard → New Project
2. 2Enter a project name
3. 3Select the Odoo version (14.0 – 19.0)
4. 4Choose your distribution (Community or Enterprise)
5. 5Optionally connect GitHub repositories for custom addons
6. 6Click "Create", indexing starts automatically
7. 7Wait for the index status to show "ready"

Asking Questions

Once your project is indexed, open a topic and type your question in natural language. Choose your search depth based on how deep you want the analysis:

• Peek (roughly 60–150 ERPeek Credits): the lightest research budget - fast answers from the structural index, best for simple lookups
• Inspect (roughly 100–260 ERPeek Credits): more research turns and more thinking - balanced review for typical implementation questions
• Deep Dive (roughly 250–900 ERPeek Credits): the largest compute and thinking budget, with many more research passes over your code - best for complex, cross-module analysis
• Costs are a range because they reflect the real, cache-inclusive model cost of each question; the exact amount is shown per answer.

Understanding Answers

Every ERPeek answer is code-grounded, meaning it cites specific files and line numbers. You'll see:

• Source citations: File paths and line numbers for every referenced code
• Source badges: Labels showing whether code comes from community, enterprise, or custom addons
• Agent timeline: A trace showing the search queries, tools used, and verification steps
• Code blocks: Syntax-highlighted code snippets from your actual codebase

Custom Addons

Connect your GitHub repositories to include custom addon code in the search. ERPeek detects overrides and inheritance automatically, prioritizing your custom code in answers when it modifies standard behavior.

1. 1Connect GitHub in Settings → Connected Accounts
2. 2When creating a project, select repositories from the list
3. 3ERPeek clones repos and indexes them alongside standard Odoo modules
4. 4Custom module overrides are automatically detected and prioritized

Database Analysis

Upload a PostgreSQL dump of your Odoo database to let ERPeek analyze your actual data alongside the codebase. The dump is loaded into an isolated environment, your records, configurations, and installed modules are queryable by the AI. Alternatively, connect a live Odoo instance for real-time access via the XML-RPC API.

1. 1In your project's left panel, click "Database" and upload a .sql or .gz dump file
2. 2ERPeek loads the dump into an isolated PostgreSQL environment scoped to your project
3. 3Ask questions referencing your actual data: installed modules, configured fields, record values
4. 4For live access: go to Project Settings → Data Source → Live Odoo API, enter your instance URL and API key

File Uploads in Topics

Attach files directly in a conversation to give the AI additional context. ERPeek supports images, PDFs, spreadsheets, and text files, all analyzed alongside the Odoo codebase in the same answer.

• Click the attachment icon in the message input to upload a file
• Images: screenshots of Odoo screens, ERD diagrams, mockups
• PDFs: specifications, audit reports, functional documentation
• Spreadsheets: data exports, mapping tables, migration plans
• Files are scoped to the topic and visible to all messages in that conversation

Answer Modes

ERPeek answers in two modes: Technical and Functional. Technical mode gives developers precise code references, method signatures, inheritance chains, and file paths. Functional mode explains the same behavior in plain language for business users, project managers, or anyone without a development background.

• Toggle between modes using the "Technical / Functional" switch in the topic header
• Technical: includes field names, model names, Python methods, XML IDs, and line numbers
• Functional: explains what the code does in business terms, ideal for specs and documentation
• Your preference is remembered per browser session
• Both modes cite the same underlying source files, only the presentation changes

Security & Data Handling

Security is built into ERPeek at every layer: TLS on every connection, sensitive credentials encrypted at rest, strict per-customer isolation, multi-factor authentication, and human approval before the assistant ever writes to your ERP. The AI reads your question and the project code and records it needs to answer, never your credentials or another customer’s data, and your data is never used to train AI models.

• TLS on every connection; sensitive credentials encrypted at rest with authenticated AES-256
• Each customer is fully isolated, you can only ever reach your own projects and data
• The assistant proposes changes; a person approves them before anything is written to your ERP
• Built for GDPR and Québec Law 25, with data-processing agreements in place with our providers

Connect your AI (MCP)

ERPeek is available as a remote MCP connector for your AI. Add it to claude.ai, Claude Code, or any MCP client such as Codex CLI to list your Odoo environments, ask code-grounded questions about your configuration and data, and draft changes that you approve on ERPeek, all from your AI conversation.

• Works in claude.ai (custom connector), Claude Code (one terminal command), and any MCP client that supports remote servers with OAuth
• You log in with your ERPeek account; read-only by default
• Write proposals never auto-execute, they are approved on ERPeek
• Questions consume ERPeek Credits from your account, same as on erpeek.ai

ERPeek Credits

ERPeek uses a credits-based model. Each question costs ERPeek Credits based on the search depth you choose and the model work required. You always see the exact credit cost on each answer.

• Peek: roughly 60–150 ERPeek Credits per question
• Inspect: roughly 100–260 ERPeek Credits per question
• Deep Dive: roughly 250–900 ERPeek Credits per question
• New accounts receive 1,000 free ERPeek Credits
• Plans: Starter 1,000 ERPeek Credits/mo, Pro 5,000/mo, Enterprise 20,000/mo. Monthly plan credits reset at each renewal; you can buy extra banked credits anytime from the Billing page, and those never expire