Installation
Requirements
Section titled “Requirements”- Node.js 20 or newer — Harnix uses modern JavaScript features (
import.meta.dirname) that require Node.js 20.11.0 or later - npm 10 or newer — ships with Node.js 20 by default
Zero-install usage
Section titled “Zero-install usage”Run Harnix directly without installing it globally. This downloads and executes the latest published version:
npx harnix scan .Global install
Section titled “Global install”Install Harnix globally to use the harnix command from any directory:
npm install --global harnixharnix scan .Run from source
Section titled “Run from source”git clone https://github.com/anakotai/harnix.gitcd harnixnpm installnode bin/harnix.js scan .Verify installation
Section titled “Verify installation”After installation, confirm the CLI is accessible and responds:
harnix --helpCheck the installed version:
harnix --versionPlatform compatibility
Section titled “Platform compatibility”Harnix runs on any operating system that supports Node.js 20 or later, including macOS, Linux, and Windows. There are no native binary dependencies — the CLI is pure JavaScript compiled from TypeScript. It works in CI environments (GitHub Actions, GitLab CI, CircleCI, Azure Pipelines) with no additional setup beyond having Node.js available.
Upgrading
Section titled “Upgrading”When installed globally, upgrade to the latest version with:
npm update --global harnixWhen using npx, you always get the latest published version by default. To pin a specific version:
npx harnix@0.14.0 scan .