Skip to content

Install and First Run

VibePro requires Node.js 20 or newer.

The published package is currently an early beta. Use the beta dist-tag when trying it from npm.

bash
npx vibepro@beta --help

For local development of VibePro itself:

bash
git clone https://github.com/Unson-LLC/vibepro.git
cd vibepro
npm install
node bin/vibepro.js --help

Where to run it

Run VibePro in the repository being changed. Even when Codex or Claude Code does the implementation, VibePro evaluates that repository's current git state.

For a web app deployed to Cloudflare Pages, VibePro does not run inside the Pages dashboard. Run it locally or in CI before creating the PR.

text
/path/to/web-app
  package.json
  src/
  docs/
  .vibepro/      # VibePro's repo-local evidence workspace

Start with vibepro init or vibepro check in the target repository, then move through agent implementation, verification, and PR preparation.

Diagnose a repository first

If you do not have a story yet, start with a repository-level check.

bash
vibepro check all /path/to/repo --base <base-branch>

Share the generated check report and every needs_review or fail item before deciding whether the repository is ready for AI-driven implementation.

Create a story

For feature or bug work, initialize VibePro with a story ID.

bash
vibepro init /path/to/repo \
  --story-id story-<short-name> \
  --title "<feature or bug title>" \
  --language en

Then run checks against that story.

bash
vibepro check all /path/to/repo \
  --story-id story-<short-name> \
  --base <base-branch>

Prepare PR evidence

When implementation work exists, run PR preparation.

bash
vibepro pr prepare /path/to/repo \
  --story-id <story-id> \
  --base <base-branch>

Open the generated artifacts in this order:

  1. .vibepro/pr/<story-id>/review-cockpit.html
  2. .vibepro/pr/<story-id>/gate-dag.html
  3. .vibepro/pr/<story-id>/split-plan.html
  4. .vibepro/pr/<story-id>/pr-body.md

<base-branch> is repository-specific. Use the target repository's real default or integration branch, such as origin/main, main, origin/develop, or develop.

Record verification evidence

After running a real command on the current git state, record it.

bash
vibepro verify record /path/to/repo \
  --id <story-id> \
  --kind unit \
  --status pass \
  --command "npm test"

Evidence should describe what actually ran. Do not record expected future verification as passed evidence.

Create a PR through VibePro

After pr prepare reports readiness, create the PR through VibePro.

bash
vibepro pr create /path/to/repo \
  --base <base-branch> \
  --head <feature-branch> \
  --story-id <story-id>

Avoid using raw gh pr create as the standard path. It bypasses VibePro's Gate DAG and waiver audit.

Released under the Apache-2.0 License.