Installation¶

Prerequisites¶

• Node.js 18+ — OCC requires Node.js version 18 or later

npm (Global Install)¶

Install OCC globally to make the occ command available everywhere:

npm i -g @cesarandreslopez/occ

Then run it from any directory:

occ docs/

npx (No Install)¶

Run OCC without installing it globally:

npx @cesarandreslopez/occ docs/ reports/

Build from Source¶

git clone https://github.com/cesarandreslopez/occ.git
cd occ
npm install
npm run build
npm link    # makes `occ` available globally

Or run in dev mode without building:

npx tsx bin/occ.ts docs/

scc Binary¶

OCC auto-downloads the scc binary (v3.7.0) during npm install for code metrics. The binary is placed in the vendor/ directory.

If the download fails, OCC falls back to looking for scc on your system PATH.

To skip the automatic download:

SCC_SKIP_DOWNLOAD=1 npm install