Skip to main content

Installation

vlayer can be installed globally via npm, or run directly with npx without installation.

Requirements​

  • Node.js 18.0 or later
  • npm 8.0 or later (or yarn/pnpm)

Global Installation​

Install vlayer globally to use it from anywhere:

npm install -g verification-layer

Verify the installation:

vlayer --version

Using npx (No Installation)​

Run vlayer directly without installing:

npx vlayer scan ./your-project

This is useful for one-off scans or CI/CD pipelines where you don't want to manage global packages.

Project-Local Installation​

Add vlayer as a dev dependency for your project:

npm install --save-dev verification-layer

Then add a script to your package.json:

{
  "scripts": {
    "hipaa-scan": "vlayer scan .",
    "hipaa-report": "vlayer scan . -f html -o hipaa-report.html"
  }
}

Run with:

npm run hipaa-scan

Updating​

Update to the latest version:

# Global installation
npm update -g verification-layer

# Project-local installation
npm update verification-layer

Uninstalling​

Remove vlayer:

# Global installation
npm uninstall -g verification-layer

# Project-local installation
npm uninstall verification-layer

Troubleshooting​

Permission Errors on Linux/macOS​

If you get permission errors with global installation, either:

  1. Use a Node version manager like nvm
  2. Configure npm to use a different directory:
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc

Node.js Version Issues​

vlayer requires Node.js 18+. Check your version:

node --version

If you need to upgrade, use nvm or download from nodejs.org.

Next Steps​

Now that vlayer is installed, proceed to the Quick Start guide to run your first scan.