https://github.com/lockblock-dev/pkg-unpacker
Unpack any pkg application
https://github.com/lockblock-dev/pkg-unpacker
bytecode decompiler javascript-app pkg reverse-engineering unpacker
Last synced: 3 months ago
JSON representation
Unpack any pkg application
- Host: GitHub
- URL: https://github.com/lockblock-dev/pkg-unpacker
- Owner: LockBlock-dev
- License: mit
- Created: 2022-08-04T15:07:02.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-08T21:26:36.000Z (4 months ago)
- Last Synced: 2025-03-31T14:11:17.731Z (3 months ago)
- Topics: bytecode, decompiler, javascript-app, pkg, reverse-engineering, unpacker
- Language: TypeScript
- Homepage:
- Size: 32.2 KB
- Stars: 78
- Watchers: 4
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# pkg unpacker
Unpack any **pkg** application.
Keep in mind that **this tool doesn't give you the full source code if the application was compiled into V8 bytecode**. See [How it works](#how-it-works).
## Table of Contents
- [Support](#support)
- [Installation](#installation)
- [Usage](#usage)
- [As a command line interface](#as-a-command-line-interface)
- [As a library](#as-a-library)
- [Features](#features)
- [How it works](#how-it-works)
- [Credits](#credits)
- [Copyright](#copyright)
## Support
As of this writing, **pkg-unpacker** supports the following tools:
| Tool | Supported | Versions | Comment |
| ----------------------------------------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------ |
| [vercel/pkg](https://github.com/vercel/pkg) | ✅ | 5.0.0 - 5.8.1 | N/A |
| [yao-pkg/pkg](https://github.com/yao-pkg/pkg) | ✅ | 5.0.0 - 6.3.2 | Does not include experimental support for [Node SEA](https://nodejs.org/api/single-executable-applications.html) . |
| [AngaBlue/exe](https://github.com/AngaBlue/exe) | ❌ | - | N/A |
## Installation
1. Install [Node.js](https://nodejs.org/).
2. Download or clone the project.
3. Navigate to the project directory.
4. Install the dependencies:
```sh
npm install
```
5. Build the project:
```sh
npm run build
```
## Usage
### As a command line interface
To start the application, run:
```sh
npm start
```
Here’s an overview of the `help` command output:
```console
Usage: pkg-unpacker [options]
Options:
-i, --input Specify the input binary file path
-o, --output Specify the output folder path (default: ".")
--run Run the unpacked binary (default: false)
-h, --help display help for command
```
#### Examples:
- Unpack a UNIX application:
```console
$ npm start -i ./pkg_app -o ./unpacked
```
- Unpack a Windows application:
```console
$ npm start -i ./pkg_app.exe -o ./unpacked
```
- Unpack a UNIX application and run it:
```console
$ npm start -i ./pkg_app -o ./unpacked --run
```
### As a library
The main logic of **pkg unpacker** lies in the [`Unpacker`](./src/unpacker.ts) class.
#### Examples:
- Unpack a UNIX application:
```ts
import Unpacker from "./src/unpacker.ts";
const main = async () => {
const unpacker = await Unpacker.create("./pkg_app");
await unpacker.unpack("./unpacked");
};
main();
```
- Unpack a Windows application and run it:
```ts
import Unpacker from "./src/unpacker.ts";
const main = async () => {
const unpacker = await Unpacker.create("./pkg_app.exe");
await unpacker.unpack("./unpacked", true);
};
main();
```
## Features
- Detects compression formats (Gzip, Brotli)
- Supports code evaluation
- Handles symlinks
- Extracts binaries from all operating systems
## How it works
This application does not decompile code. By default, [pkg](https://github.com/vercel/pkg) compiles JavaScript into V8 bytecode. Extracted files will remain in this format, except for assets.
Code evaluation works best with small applications as dependencies might be broken.
[pkg](https://github.com/vercel/pkg) stores metadata about file names, paths, offsets, lengths, and compression at the end of each binary. This application analyzes those fields to extract and decompress (if necessary) all embedded files.
Examples:
```js
// UNIX app
{"/snapshot/pkg/index.js":{"0":[0,568],"3":[568,118]},"/snapshot/pkg":{"2":[686,12],"3":[698,117]},"/snapshot":{"2":[815,7],"3":[822,117]}} // virtual file system
,
"/snapshot/pkg/index.js" // entrypoint
,
{} // symlinks
,
{} // files dictionnary
,
0 // 0: no compression, 1: Gzip, 2: Brotli
```
```js
// Windows app
{"C:\\snapshot\\pkg\\index.js":{"0":[0,568],"3":[568,118]},"C:\\snapshot\\pkg":{"2":[686,12],"3":[698,117]},"C:\\snapshot":{"2":[815,7],"3":[822,117]}} // virtual file system
,
"C:\\snapshot\\pkg\\index.js" // entrypoint
,
{} // symlinks
,
{} // files dictionnary
,
0 // 0: no compression, 1: Gzip, 2: Brotli
```
## Credits
[pkg](https://github.com/vercel/pkg)
## Copyright
See the [license](/LICENSE).