zeit/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 executable file that runs without a pre-installed runtime on the target machine.
The tool uses a virtual filesystem bundler to embed project assets and native modules into a binary snapshot. It includes a bytecode obfuscator that compiles source code into bytecode to prevent the extraction of raw logic.
The project supports cross-platform distribution, allowing the generation of binaries for different operating systems and architectures from a single host machine. It handles binary size compression through GZip or Brotli and provides mechanisms for programmatic packaging trigger within custom build pipelines.
Features
- Standalone Executable Compilers - Bundles a runtime and application code into a single standalone binary that runs without a local runtime installation.
- Node.js Project Bundlers - Bundles Node.js projects and their dependencies into single standalone executable files.
- Snapshot Bundling - Embeds project assets and dependencies into a virtual filesystem snapshot that the runtime reads as if they were on disk.
- Embedded Binary Snapshots - Embeds project assets and native modules into a virtual snapshot filesystem inside the binary.
- Virtual Filesystem Bundling - Collects specified files and detects used assets to embed them in a virtual snapshot filesystem.
- Cross-Platform Binary Distribution - Packages a single codebase into native executables for multiple desktop operating systems to simplify software delivery.
- Standalone Application Packaging - Packages applications into single-file binaries to eliminate the need for pre-installed runtimes.
- Cross-Platform Executable Packagers - Compiles code into distributable standalone binaries for multiple operating systems from a single host.
- Cross-Platform Compilers - Generates executable files for different operating systems and architectures from a single host machine.
- Node.js Binary Compilation - Converts JavaScript projects into standalone executables including native addons and assets for easier deployment.
- Cross-Platform Binary Generation - Generates platform-specific executable binaries for diverse CPU architectures and operating systems from a single host.
- Native Addon Extraction - Extracts bundled native binary modules to temporary disk locations at runtime to facilitate OS loading.
- Binary Asset Embedding - Bakes non-code project assets like images or styles directly into the compiled executable binary.
- Binary Size Optimizations - Reduces the final executable size by compressing the embedded filesystem using Brotli or GZip.
- Bytecode Obfuscators - Compiles source code into bytecode to prevent easy extraction of raw logic from the executable.
- Source Obfuscation - Compiles JavaScript source into binary bytecode to hide raw logic within the executable.
- Native Module Bundling - Bundles compiled native modules into the executable and manages the disk extraction required to load them.
- Runtime Options Embedding - Bakes engine flags and runtime configurations directly into the binary executable for consistent execution.
- Source Code Protection - Secures application logic by converting source code into bytecode within a compiled binary to prevent extraction.
- Source Code Obfuscation - Compiles source code into bytecode to obscure raw logic and prevent easy extraction.
- Build Tools - Packages Node.js projects into executable binaries.
