Installation

Requirements

CodeGuard requires Node.js 24 or later and npm. Node.js 24 is the supported development and runtime line.

Local development

Clone the repository and install the locked dependencies:

git clone https://github.com/ItayLeon-Max/codeguard.git
cd codeguard
nvm use
npm ci
npm run build

On Windows, use nvm-windows or install Node.js 24 using the official installer. Run npm commands in PowerShell or Command Prompt.

To expose the local checkout's executable for development, run npm link from the repository. This is for development convenience; package validation uses an installed tarball instead.

Install the public beta

Install the current beta globally from npm:

npm install -g codeguard-local@beta
codeguard --version

The beta dist-tag may move when another beta is published. To install this exact candidate instead, use npm install -g codeguard-local@0.5.0-beta.0.

Verify the published CLI:

codeguard --help
codeguard --version

If your shell cannot find codeguard, check npm prefix -g and ensure its executable directory is on PATH. On Windows, npm's global prefix directory must be available to PowerShell or Command Prompt.

Verify the checkout

node --version
npm --version
npm run build
node dist/cli/index.js --help
node dist/cli/index.js --version