Vibenv Documentation

Appearance

Vibenv ships as scoped packages. Start by configuring npm to pull from the Vibenv registry.

.npmrc ​

ini
@vibenv:registry=https://npm.vibenv.net/

Then authenticate with the Vibenv registry:

bash
npm login --scope @vibenv

Login details will be provided by the Vibenv team.

Core packages ​

bash
npm install @vibenv/vibe-server @vibenv/constants @vibenv/cli-agents @vibenv/vibe-agent
  • @vibenv/vibe-server provides the Express router that serves the agent endpoints.
  • @vibenv/cli-agents routes prompts to Claude Code (local or remote).
  • @vibenv/constants exposes shared constants like data-component-file/data-component-name attributes and __PROJECT_ROOT__.
  • @vibenv/vibe-agent exports ./vibeagent.js from its package build. Serve it from your static assets at the injected path (default /vibeagent.js); on webpack-dev-server, WebpackVibeAgentHandlerPlugin can serve it directly.

Integration packages ​

Install the integration package that matches your stack:

Vite ​

bash
npm install @vibenv/vite-plugins

Webpack ​

bash
npm install @vibenv/webpack-plugins

Framework helpers ​

bash
npm install @vibenv/framework-plugins