@nodehunter/core

Pure TypeScript engine for nodehunter — the same scan, size, workspace, and delete logic as the CLI, without shelling out.

No console.* and no process.* in core — your host passes HostOperationContext (platform, scan path, flags) so the same code runs in Node scripts, CI, and custom tools.

Install

Requires Node.js >= 18.

npm install @nodehunter/core
# or: pnpm add @nodehunter/core

CLI package vs SDK package

| Install | Best for | |---------|----------| | npm install nodehunter | Terminal CLI — self-contained binary plus optional nodehunter/core import from the same tarball (not a runtime dep on @nodehunter/core) | | npm install @nodehunter/core | Apps, CI jobs, and libraries that embed scan/size/delete without the CLI binary (recommended for imports) |

You do not need both for most projects. Pick the CLI for command-line use, or @nodehunter/core when you import APIs directly.

Quick start

import {
  createHostRunSession,
  createSuggestionHostContext,
  resolveHostPlatform,
  runScan,
} from '@nodehunter/core';

const ctx = {
  runtime: {
    cwd: process.cwd(),
    platform: resolveHostPlatform(process.platform),
  },
  scan: { path: process.cwd() },
  suggestions: createSuggestionHostContext(process.platform),
  session: createHostRunSession(),
};

const { analysis, output } = await runScan(ctx);

Runnable examples: examples/sdk/ in the nodehunter repository.

Subpath exports

| Subpath | Stability | Purpose | |---------|-----------|---------| | @nodehunter/core | stable | Public SDK surface (runScan, runSize, envelopes, …) | | @nodehunter/core/shared | stable | Shared scanner helpers and constants | | @nodehunter/core/advanced | advanced | Low-level run emitters | | @nodehunter/core/internal | internal | CLI host globals — not for external apps |

Run pnpm exports:validate in the monorepo before releases.

Documentation

• SDK overview
• SDK examples
• SDK exports and stability
• Export governance scripts
• Platforms and sizing

License

MIT