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:

• Quick Search (2 tokens): Fast answers from the structural index — best for simple lookups
• Standard Search (5 tokens): Balanced search combining vectors and structure — good for most questions
• Deep Search (12 tokens): Full multi-agent pipeline with verification — best for complex analysis

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

Token System

ERPeek uses a token-based pricing model. Each question costs tokens based on the search depth you choose. Tokens never expire and can be purchased at any time.

• Quick Search: 2 tokens per question
• Standard Search: 5 tokens per question
• Deep Search: 12 tokens per question
• New accounts receive 50 free tokens
• Purchase more tokens at any time from the Billing page