Package your Node.js project into a single self-contained executable.
📚 Full documentation: yao-pkg.github.io/pkg
Sponsored by
pkg takes your Node.js project and ships it as a single binary that runs on devices without Node.js installed. Cross-compile for Linux, macOS, and Windows from any host.
npm install -g @yao-pkg/pkgpkg .That's it. pkg reads package.json, follows the bin entry, walks your dependencies, and produces executables for Linux, macOS, and Windows.
Everything lives on the docs site:
- Getting started — install, CLI reference, first build
- Targets — cross-compile for other platforms
- Configuration —
pkgproperty inpackage.json, scripts, assets, ignore - SEA vs Standard mode — which packaging mode to pick and why
- Snapshot filesystem — how paths work at runtime
- Native addons, ESM support, API
- Troubleshooting
- Architecture — traditional mode vs enhanced SEA mode
- Contributing — release process, running tests
This is yao-pkg/pkg — the actively maintained fork of the archived vercel/pkg. New releases ship as @yao-pkg/pkg.
