{"id":16760335,"url":"https://github.com/roccomuso/upx","last_synced_at":"2025-09-14T05:31:20.673Z","repository":{"id":45789841,"uuid":"99029166","full_name":"roccomuso/upx","owner":"roccomuso","description":"Node.js cross-platform wrapper for UPX - the ultimate packer for eXecutables.","archived":false,"fork":false,"pushed_at":"2019-02-22T10:26:30.000Z","size":2063,"stargazers_count":35,"open_issues_count":2,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-28T21:35:18.913Z","etag":null,"topics":["binaries","compression","executable","js","nodejs","upx","wrapper"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/roccomuso.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-01T17:59:55.000Z","updated_at":"2024-08-12T19:31:41.000Z","dependencies_parsed_at":"2022-07-17T00:46:04.925Z","dependency_job_id":null,"html_url":"https://github.com/roccomuso/upx","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roccomuso%2Fupx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roccomuso%2Fupx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roccomuso%2Fupx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roccomuso%2Fupx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roccomuso","download_url":"https://codeload.github.com/roccomuso/upx/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232954591,"owners_count":18602151,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["binaries","compression","executable","js","nodejs","upx","wrapper"],"created_at":"2024-10-13T04:23:09.594Z","updated_at":"2025-01-07T23:53:58.640Z","avatar_url":"https://github.com/roccomuso.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# upx\n\n[![NPM Version](https://img.shields.io/npm/v/upx.svg)](https://www.npmjs.com/package/upx)\n[![Dependency Status](https://david-dm.org/roccomuso/upx.png)](https://david-dm.org/roccomuso/upx)\n[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\n\u003e Node cross-platform wrapper for [UPX](https://github.com/upx/upx)\n\n## Install\n\n    $ npm install --save upx\n\n## Usage\n\n```javascript\nconst UPX = require('upx')(opts) // see options below\n\nUPX('Hello.exe')\n.output('Compressed.exe')\n.start().then(function(stats){\n  /* stats:\n  { cmd: 'compress',\n    name: 'Compressed.exe',\n    fileSize: { before: '1859072', after: '408064' },\n    ratio: '21.95%',\n    format: 'win32/pe',\n    affected: 1 }\n  */\n}).catch(function (err) {\n  // ...\n})\n```\n\n### Methods\n\n**`upx(\u003cpath\u003e)`** : path is the absolute path to the file to compress/decompress.\n\n**`.output(\u003coutput\u003e)`** : path to the output file.\n\n**`.start()`** : Start the compress/decompress process.\n\n### Options\n\nThe options below can be true or false.\n\n| Option | Description |\n|--------|-------------|\n| `faster` | compress faster |\n| `better` | compress better |\n| `best` | compress best (can be slow for big files) |\n| `decompress` | decompress |\n| `list` | list compressed files |\n| `force` | force compression of suspicious files |\n| `brute` | try all available compression methods \u0026 filters (slow) |\n| `ultraBrute` | try even more compression variants (very slow) |\n| `overlayCopy` | copy any extra data attached to the file (default) |\n| `overlayStrip` | strip any extra data attached to the file (dangerous) |\n| `overlaySkip` | don't compress a file with an overlay |\n| `8086` | make compressed sys work on any 8086 (for dos) |\n| `noReloc` | put no relocations in to the exe header (for dos) |\n| `8bit` | uses 8 bit size compression (default: 32 bit) |\n| `8mibRam` | 8 megabyte memory limit (default 2MiB) |\n\n## Debug\n\nset the env DEBUG: `DEBUG=upx node myScript.js`\n\n# Author\n\nRocco Musolino ([@roccomuso](https://twitter.com/roccomuso))\n\n# License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froccomuso%2Fupx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froccomuso%2Fupx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froccomuso%2Fupx/lists"}