Public files
Reference
Package names, exports, and schemas.
This page collects the stable entrypoints and formats you are most likely to use when integrating VibeDocs into a repository or a toolchain.
| Area | Stable contract | Notes |
|---|---|---|
| Package | @leapx-ai/vibedocs |
Public npm package for VibeDocs. |
| Binary | vibedocs |
CLI entrypoint for local-first docs operations. |
| Public exports |
@leapx-ai/vibedocs@leapx-ai/vibedocs/config@leapx-ai/vibedocs/reporting@leapx-ai/vibedocs/rule-engine
|
Keep additions backward compatible; do not remove lightly. |
| Report schema | schemas/report.schema.json |
Results include diff-aware suggested_docs hints. |
| Rule pack schema | schemas/rule-pack.schema.json |
Local read-only overrides for severity, suggestion, owner hint, or disable. |
Release rules
Versioning and publish flow
- SemVer for CLI, public exports, and report schema evolution.
CHANGELOG.mdmust move withpackage.jsonversion updates.- Git tag format:
vX.Y.Z. - GitHub Release triggers package publishing.