Documentation

Getting Started

ERPeek is an AI app for running an Odoo implementation and the support that follows it. It reads your actual Odoo, the standard source for your version, your custom addons, and your live configuration and data, then answers questions, plans the work, builds and ports modules, and writes the documentation. Sign up, create a project, and everything below is reachable from it.

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 – 20.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"
8. 8Fill in Project context: your business, the Odoo apps in scope, and the business-process questions. This is what makes answers specific to you

Configuring a Project

A project is configured from four places, reachable from the project header. Each one feeds the same agent, so anything you set here changes the answers you get everywhere else.

• Project context: describe the business, pick the Odoo apps in scope, and answer the business-process questions. The agent reads these answers, so a filled-in context produces answers about your operation rather than about Odoo in general
• Code: the Odoo version and distribution, plus any GitHub repositories holding your custom addons
• Database: a SQL dump, a live Odoo connection, or both
• Memories: the project brain, the notes ERPeek keeps between conversations

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
• Export: any answer can be saved as a DOCX or PDF document, which is how a question becomes a process guide you hand to the team
• An answer that cannot be grounded in code or data the agent actually read is refused rather than guessed

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 and Live Odoo

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, add an environment under Database: enter the Odoo URL and credentials and ERPeek discovers the database name for you, then tests the connection before saving it
5. 5Label each environment production, staging or development. An environment you have not labelled stays unclassified, and ERPeek will not treat it as production on your behalf
6. 6A project can hold several environments at once, so the same questions can be asked against staging and production

Permissions and Governed Writes

ERPeek is read-only until you say otherwise. Write access is granted capability by capability, per environment, and every write is proposed before it happens. Nothing reaches your Odoo without a person approving it.

1. 1Open the environment and turn on "Let the agent change data in Odoo"
2. 2Grant only the capabilities you want: create, update or delete records, system configuration, user, accounting and HR records, installing and upgrading apps
3. 3A production environment needs a second, explicit switch, "Allow writes on this production environment", so a staging grant never silently applies to production
4. 4The agent proposes a change, you review exactly what it will do, then approve or reject it
5. 5Approved and rejected actions are both kept in the action history on the project

• Browsing capabilities are separate from write capabilities: browsing the live Odoo interface, taking screenshots, and clicking and typing while exploring are each granted on their own
• Some operations are blocked outright and cannot be granted at all
• Revoking a capability takes effect immediately; pending proposals that need it can no longer be executed

Implementation Plan and Tasks

A project carries its own implementation plan: phases, tasks, owners and progress, so the work is visible to everyone on the project rather than living in a spreadsheet somebody maintains by hand.

• Tasks are grouped into phases; each task carries checklist items, an owner and a status
• The plan view rolls the tasks up into per-phase progress and a Gantt, and marks work as planned or blocked
• Any task can be opened as a conversation, so the question you need answered to finish it starts with the task already in context
• Tasks can be added, reordered and moved between groups as the project changes

Go-Live Readiness

The readiness view reads the evidence in your connected Odoo and turns it into an Odoo configuration checklist: what is set up, what is missing, and what still needs a decision before you can go live.

• It works from the apps you selected in Project context, so fill that in first
• Each item links to the work that clears it, either a configuration change or a question to work through
• Business-process questions surface the decisions nobody has made yet, which are usually what actually delays a go-live

Module Pipeline

The module pipeline builds custom Odoo modules. You describe the capability you need; the pipeline writes the module, installs it in a throwaway Odoo, runs it, repairs what fails, and delivers the result.

• Delivery is a ZIP you can install yourself, or a pull request into your own repository
• Existing modules can be modified, not only new ones created
• The module is verified by actually installing and running it, not only by generating code that looks right

Migration Pipeline

The migration pipeline assesses an existing Odoo project and ports it to a newer version. It starts with an assessment of what you have, then works module by module with your approval at each gate.

• Assessment first: what is installed, what is customized, and what will actually be affected by the version change
• Modules are ported one at a time, and you approve, retry or skip each one
• Data-migration scripts and the decisions behind them are surfaced for review rather than applied silently
• A rehearsal environment lets the cutover be practised before it is scheduled

Live Dashboards

Ask for a dashboard in a conversation and ERPeek builds one against your live Odoo data. Dashboards live on the project and refresh from the connection rather than from a static export.

• A dashboard is created from a topic, so the question that produced it stays attached to it
• Dashboards can be shared with a link for people who do not have an ERPeek account
• They need a live Odoo connection; a SQL dump alone is a snapshot, not a live source

Project Memory

ERPeek keeps a project brain: the durable notes it has built up about your environment, decisions and conventions. It is read at the start of every conversation, so the tenth question does not start from nothing.

• The brain is browsable: you can read every note ERPeek is working from
• Memory is scoped to the project, never shared between projects or customers
• The knowledge base can be exported, so what ERPeek has learned about your setup is portable

Sharing a Project

Projects can be shared with colleagues by email invitation. The person you invite gets their own ERPeek account and their own view of the project, at the level of access you grant.

• Roles: manager, member and guest, alongside the owner
• An invitation is pending until accepted, and access can be revoked at any time
• Questions asked by a person you invited are billed to the account that owns the project

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