Installation

vybdocs ships as a single CLI binary called vyb. It requires Node.js 24 or higher (or the Bun runtime). The CLI is published to npm and can be installed globally or used via npx.

Requirements

Requirement	Version
Node.js	24.0+
Bun (alternative)	1.1+
npm / pnpm / yarn	any recent
Git	2.30+

info

vybdocs uses Node.js 24 because it ships native ES module support and the built-in fetch API without flags. If you are on an older Node version, we strongly recommend upgrading before proceeding.

Install globally with npm

npm install -g @vybdocs/vyb

Verify the installation:

vyb --version
# v1.0.0

Install globally with Bun

bun install -g @vybdocs/vyb

Project-local install (recommended for teams)

For reproducibility, install vyb as a dev dependency in your project. This ensures everyone on the team uses the same version.

npm install --save-dev @vybdocs/vyb

Then run it via your package scripts or npx:

npx vyb check

Or add it to your package.json scripts:

package.json

{
  "scripts": {
    "check": "vyb check",
    "check:dry": "vyb check --dry-run"
  }
}

Using npx (no install)

If you want to try vybdocs without installing:

npx @vybdocs/vyb init
npx @vybdocs/vyb check

Verifying the install

After installation, run:

vyb --version         # prints the CLI version
vyb --help            # lists all commands
vyb check --help      # details on the check command

Expected output from vyb --help:

vyb <command>

Commands:
  vyb init [options]      Initialize a .vyb/spec.yaml in the current project
  vyb check [options]     Run constraint checks against the current diff
  vyb pack [options]      Manage and emit rule packs
  vyb ui                  Start the vybdocs web UI at localhost:7777
  vyb mcp                 Start the MCP server for Claude Desktop

Options:
  --version               Show version number
  --help                  Show help

Shell completions

Enable tab completion for your shell:

# Bash
vyb completion bash >> ~/.bashrc

# Zsh
vyb completion zsh >> ~/.zshrc

# Fish
vyb completion fish > ~/.config/fish/completions/vyb.fish

CI environments

In GitHub Actions and other CI environments, you typically install vyb as part of your workflow. See GitHub Actions for a ready-made workflow file.

For ephemeral CI runners, use npx @vybdocs/vyb check to avoid a global install step:

.github/workflows/vyb-check.yml

- name: Run vybdocs check
  run: npx @vybdocs/vyb check --ci

The --ci flag formats output for CI log renderers (no color, structured exit codes).

Upgrading

npm update -g @vybdocs/vyb    # global
npm update --save-dev @vybdocs/vyb  # project-local

Uninstalling

npm uninstall -g @vybdocs/vyb

---

Next: Quick Start