vercel/pkgArchived
Pkg
pkg is a Node.js executable packager and cross-platform binary compiler. It bundles a project and its dependencies into a single standalone binary, allowing applications to run on machines without a pre-installed runtime.
The project distinguishes itself by precompiling JavaScript source code into bytecode to remove human-readable text and obfuscate the logic. It utilizes a virtual filesystem bundler to embed static assets and non-javascript files directly into the executable, employing compression algorithms to reduce the final binary size.
The tool covers cross-platform compilation for various operating systems and CPU architectures. It also handles native module packaging by extracting compiled addons to temporary disk locations at runtime to ensure compatibility with system loading mechanisms.
The system allows for the embedding of specific runtime options and engine flags directly into the generated binary.
Features
- Standalone Runtime Bundling - Bundles the Node.js runtime and application code into a single standalone executable file.
- Standalone Applications - Bundles application code, dependencies, and static assets into one portable file for simpler installation.
- Executable Packagers - Bundles a Node.js project and its dependencies into a single standalone binary for distribution.
- Embedded Asset Bundlers - Provides a virtual filesystem bundler to embed static assets and non-javascript files directly into the generated executable.
- Standalone Executable Generators - Converts interpreted scripts and dependencies into standalone binary executables to remove runtime interpreter dependencies.
- Asset Embedding - Embeds static resources directly into executable binaries to improve portability and distribution.
- Virtual Filesystem Schemes - Maps embedded files and folders to a virtual directory that the application reads as if they were on disk.
- Application Distribution Tooling - Packages Node.js projects into standalone executables that run on machines without a pre-installed runtime.
- Binary Asset Embedding - Bakes project files and directory structures directly into the compiled executable binary using compression.
- Precompilation - Precompiles JavaScript source code into V8 bytecode to obfuscate logic and accelerate application startup.
- Cross-Platform Binary Generation - Generates platform-specific executable binaries for diverse CPU architectures and operating systems.
- Code Obfuscators - Precompiles JavaScript source code into V8 bytecode to remove human-readable text and obfuscate application logic.
- Executable Compression Algorithms - Employs compression algorithms to reduce the final size of the embedded filesystem within the executable binary.
- Native Addon Extraction - Extracts compiled native addons to temporary system directories at runtime to ensure OS compatibility.
- Obfuscation - Precompiles source code into bytecode to remove human-readable text from the final executable.
- Native Addon Loaders - Supports the execution of compiled binary modules and native addons within the bundled executable.
- Build and Bundling - Utility to package Node.js projects into standalone executables.
