NODE-PRE-GYP(1)

📦 version 1.0.11+~2.0.3, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 NODE-PRE-GYP(1) 💖

okay bestie, welcome to node-pre-gyp — the native addon binary install tool. yes it's a whole mouthful, yes it's iconic, let's get into it 🫶

✨ NAME ✨

node-pre-gyp — native addon binary install tool. that's the whole vibe. it's the girl who handles your compiled native modules so you don't have to compile them yourself, periodt 💅

🌸 DESCRIPTION 🌸

so the way you talk to her is like this:

Usage: node-pre-gyp <command> [options]

where <command> is one of these queens 👑:

  • clean — Removes the entire folder containing the compiled .node module. girl gets the broom out, no survivors 🧹
  • install — Attempts to install pre-built binary for module. lowkey the main character of the whole operation ✨
  • reinstall — Runs "clean" and "install" at once. two steps, one slay 🔥
  • build — Attempts to compile the module by dispatching to node-gyp or nw-gyp. she's handing it off to the gyp girlies 🎀
  • rebuild — Runs "clean" and "build" at once. wipe it, then build it, in one go 💫
  • package — Packs binary (and enclosing directory) into locally staged tarball. tarball szn 📦
  • testpackage — Tests that the staged package is valid. vibe check on the package 🦋
  • publish — Publishes pre-built binary (requires aws-sdk). big moment, but heads up — this one requires aws-sdk ⭐
  • unpublish — Unpublishes pre-built binary (requires aws-sdk). the take-backs, also requires aws-sdk 😭
  • info — Lists all published binaries (requires aws-sdk). window shopping, again requires aws-sdk 💀
  • testbinary — Tests that the binary.node can be required. does it even load?? let's find out 🙈
  • reveal — Reveals data on the versioned binary. the tea ☕, spilled
  • configure — Attempts to configure node-gyp or nw-gyp build. setting the stage before the show 🌈
ngl bestie, note the pattern: anything that touches the internet shelf — publish, unpublish, info — is gonna need aws-sdk. no aws-sdk, no service. fr fr 💅

that's the whole page, babe. go forth and pre-gyp responsibly 💖

✿ this lil guide was written up in April 2016, for the NODE-PRE-GYP(1) manual ✿ 🎀🦋💜

📦 where this page comes from