How to Use the Docs

Get the most out of the Vendure documentation with powerful search, AI-ready endpoints, and ways to help improve the docs.

Powerful Search

Find what you need quickly with our hybrid search system that combines semantic understanding with keyword matching. Use Cmd/Ctrl + K to open search from anywhere.

Cmd+Kto open search

AI & Coding Agent Ready

Integrate our documentation directly into your AI workflows. Access markdown versions of any doc page or use the llms.txt endpoint for full context.

# Fetch docs as markdowncurl -H "Accept: text/markdown" \  docs.vendure.io/current/framework/...# Get AI context filecurl docs.vendure.io/llms.txt

Copy the URL or click "View as markdown" on any doc page.

Help Us Improve

Found a bug or have a suggestion? Use the bug report button in the bottom-right corner of any page, or share feedback via the footer. Join our Discord community to connect with other developers.

Discord·GitHub·Community

Coming Soon

We're working on exciting new features to make the docs even more helpful. Stay tuned for AI-powered explanations and an interactive chat assistant.

Explain with AI - Get AI explanations for any code block
AI Chat Assistant - Ask questions and get instant answers

Use the Docs in Your Coding Assistant

Connect the Vendure docs MCP server and your coding assistant can search the Vendure docs and read any page while it works. With a free linked Project, it also gets step-by-step workflows to build a plugin, review a plugin, and set up plugin tests, plus Vendure conventions for each part of a plugin, including entities, services, strategies, and Dashboard forms. It costs nothing, and your assistant and model run on your machine.

Connect in Three Steps

Add the MCP server URL in your coding assistant.

Run this command in your terminal:

claude mcp add vendure-docs --transport http https://docs.vendure.io/mcp

Or add the server to .mcp.json in your project root:

.mcp.json

{  "mcpServers": {    "vendure-docs": {      "url": "https://docs.vendure.io/mcp"    }  }}

2
The first time you use a development tool, the assistant asks you to sign in with Vendure Console. Sign in and select your account.
The development tools are the workflows and patterns. Search and public doc pages work without sign-in. Vendure Platform docs also ask you to sign in.
3
In your Vendure application directory, run the link command and select your Project.
vendure console link
Linking does not configure or sign in to any coding assistant. For details, see the CLI guide.

What You Get

Without sign-in

Search all public Vendure docs
Read any public page as Markdown

With a free linked Project

Everything without sign-in
Workflows to build a plugin, review a plugin, and set up plugin tests
Vendure conventions for each part of a plugin, including entities, services, strategies, and Dashboard forms
Available to every member with development permission on the Project

A Project in Vendure Console is free. No plan or trial needed.

Create a free Project in Vendure Console Link your project