Installation

Choose the installation method that fits your workflow. You can run VibeGuard instantly, install it globally, or add it as a development dependency to your project.

Run Instantly (No Install Needed)

The fastest way to scan your project is to use npx. This downloads and runs the latest version of VibeGuard without permanently installing it.

npx vibeguard-scan scan .

Install Globally

If you want to use VibeGuard across multiple projects without typing npx every time, you can install it globally via npm:

npm install -g vibeguard-scan

Once installed, you can simply run:

vibeguard scan .

Install as a Dev Dependency

To ensure everyone on your team is using the same version of VibeGuard, it's highly recommended to install it locally as a development dependency.

npm install -D vibeguard-scan

You can then add a script to your package.json:

{
  "scripts": {
    "scan": "vibeguard-scan scan ."
  }
}