CODYGIENE

Installation

Prerequisites

  • Node.js 20 or later
  • npm, pnpm, or yarn (npm comes with Node.js)

Verify Node.js is installed:

node --version

You need Node.js 20 or later. If you have an older version, upgrade from nodejs.org.

Install the CLI

After the package is published to npm:

npm install -g codygiene@beta

With pnpm:

pnpm add -g codygiene@beta

With yarn:

yarn global add codygiene@beta

Current release status

CODYGIENE 0.9.1-beta.1 is prepared for public beta testing but has not yet been published to npm. The commands above will work once the package is published under the beta dist-tag.

Until publication, install from the beta package file:

npm install -g codygiene-0.9.1-beta.1.tgz

Verify installation

codygiene --version

Expected output:

codygiene 0.9.1-beta.1
engine 1.0.0
ruleset 1.0.0

Run the help command to see all available options:

codygiene --help

Upgrade

npm update -g codygiene

Uninstall

npm uninstall -g codygiene

After installation, scanning runs entirely offline · no network access is needed for analysis.

Next steps