AI-readable
Give requirements, decisions, structure, and status a stable context
Reduce the need for one-off explanations by keeping the project context in a form that AI tools can actually consume and reuse.
Open-source docs toolkit
Make projects easier for AI to understand, teams to collaborate on, and development to sustain.
VibeDocs uses structured documents, feature packages, and local checks to turn scattered project context into a working foundation that both AI and teams can keep relying on.
CLI:
vibedocs
Package: @leapx-ai/vibedocs
License: Apache-2.0
Core value
Three outcomes define the system.
The goal is not just to create documents. The goal is to make the project easier to understand, easier to align around, and easier to keep developing.
Collaboration-aligned
Keep the team working from one documentation system
Let product, design, engineering, and delivery align around the same files instead of maintaining separate interpretations.
Built to evolve
Keep docs moving with the product instead of aging after launch
Use feature packages and audit to keep documentation evolving with iteration instead of turning into a historical snapshot.
What it provides
A docs system you can adopt inside an existing repo.
VibeDocs stays close to plain files. You do not need a hosted platform or a new editor to make documentation more structured and maintainable.
Templates
Reusable document starters
Start from opinionated templates for governance, product, engineering, delivery, operations, and feature-level documentation.
Scaffold
A docs tree you can drop into a repo
Generate a Minimal, Standard, or Full structure so the first version of the docs system is created consistently instead of by hand.
CLI
Local commands for setup and checks
Use init, feature create, audit, and
glossary check to keep documentation practical and current.
How to start
Three steps are enough for the first run.
1. Install
Add the public package to your repository and use the local binary.
npm install @leapx-ai/vibedocs
2. Generate docs
Initialize a baseline docs system, then add focused packages for real features.
npx vibedocs init --mode minimal npx vibedocs feature create focus-mode
3. Keep it aligned
Run audits and glossary checks as part of daily development, not just at release time.
npx vibedocs audit --changed src/app.js
Read next
Use Quickstart for the first run, then keep CLI and Reference nearby.
The public site focuses on what VibeDocs is and how to use it. Go deeper with the Quickstart, command reference, concepts, and schemas when you need them.