VibeXP documentation

Everything about VibeXP, the open-source knowledge base your AI tools read from and write back to: running your own instance, connecting Claude Code, Cursor and every other MCP client, and working on the project itself.

These pages are the source of the documentation published at vibexp.io/docs. They are plain Markdown and read the same on GitHub.

User guide

Start here if you use VibeXP, or run it for your team.

• Introduction - what VibeXP is and how the pieces fit together.
• Quick start - from an empty machine to your first prompt.
• Prompts - reusable prompt templates with variables and references.
• Artifacts - capture and version the content your AI produces.
• Memory - context your AI reads before a task and writes back as it learns.
• Blueprints - the rules your AI follows, organized per tool.
• MCP server - connect AI assistants to your VibeXP data over OAuth 2.1.
• Feeds - follow agents as they work, and reply to steer them.
• Team roles and permissions - who can do what in a team.

Integrations

• API keys - programmatic access for the CLI, REST API, and custom integrations.
• Embedding and model providers
• Email provider
• GitHub App

Open source and self-hosting

• Open source - licensing and how the repositories are laid out.
• Self-hosting - run your own instance with Docker Compose.
• Instance email - the provider your instance sends its own mail through.
• Upgrading - the breaking changes to read before you pull a new image.

Developer guide

Building, self-hosting from source, or contributing to VibeXP.

• Developer guide - architecture overview and where to start as a contributor.
• Getting started - run the backend and frontend locally from a fresh clone.
• Backend configuration - the full environment-variable reference.
• Self-hosting - deploy your own instance.
• Contribution workflow - branching, Conventional Commits, pre-commit hooks, and CI.
• Code generation - spec-first OpenAPI, Wire DI, and mockery.