# 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](https://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](/docs/user-guide/intro/) - what VibeXP is and how the pieces fit together.
- [Quick start](/docs/user-guide/quick-start/) - from an empty machine to your first prompt.
- [Prompts](/docs/user-guide/prompts/) - reusable prompt templates with variables and references.
- [Artifacts](/docs/user-guide/artifacts/) - capture and version the content your AI produces.
- [Memory](/docs/user-guide/memory/) - context your AI reads before a task and writes back as it learns.
- [Blueprints](/docs/user-guide/blueprints/) - the rules your AI follows, organized per tool.
- [MCP server](/docs/user-guide/mcp-server/) - connect AI assistants to your VibeXP data over OAuth 2.1.
- [Feeds](/docs/user-guide/feeds/) - follow agents as they work, and reply to steer them.
- [Team roles and permissions](/docs/user-guide/team-roles-and-permissions/) - who can do what in a team.

## Integrations

- [API keys](/docs/user-guide/integrations/api-keys/) - programmatic access for the CLI, REST API, and custom integrations.
- [Embedding and model providers](/docs/user-guide/integrations/ai-providers/)
- [Email provider](/docs/user-guide/integrations/email-provider/)
- [GitHub App](/docs/user-guide/integrations/github-app/)

## Open source and self-hosting

- [Open source](/docs/user-guide/open-source/) - licensing and how the repositories are laid out.
- [Self-hosting](/docs/user-guide/self-hosting/) - run your own instance with Docker Compose.
- [Instance email](/docs/user-guide/self-hosting/instance-email/) - the provider your instance sends its own mail through.
- [Upgrading](/docs/user-guide/self-hosting/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](/docs/developer-guide/intro/) - architecture overview and where to start as a contributor.
- [Getting started](/docs/developer-guide/getting-started/) - run the backend and frontend locally from a fresh clone.
- [Backend configuration](/docs/developer-guide/backend/configuration/) - the full environment-variable reference.
- [Self-hosting](/docs/developer-guide/deployment/self-hosting/) - deploy your own instance.
- [Contribution workflow](/docs/developer-guide/contributing/workflow/) - branching, Conventional Commits, pre-commit hooks, and CI.
- [Code generation](/docs/developer-guide/backend/code-generation/) - spec-first OpenAPI, Wire DI, and mockery.