{"id":25461635,"url":"https://github.com/sectly/exeup","last_synced_at":"2026-02-11T12:40:03.532Z","repository":{"id":276795644,"uuid":"930325783","full_name":"Sectly/Exeup","owner":"Sectly","description":"Exeup: Pack up and bundle your Node.js project into a single .exe file for easy distribution and hassle-free execution on Windows!","archived":false,"fork":false,"pushed_at":"2025-02-12T09:17:25.000Z","size":76,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-10T21:09:08.209Z","etag":null,"topics":["binary","build","bundle","compile","exe","exeup","node","windows"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/exeup","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Sectly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-02-10T13:05:06.000Z","updated_at":"2025-02-12T09:17:28.000Z","dependencies_parsed_at":"2025-02-10T14:26:36.882Z","dependency_job_id":"9dc7d50e-5121-4707-b6cf-f9521944b610","html_url":"https://github.com/Sectly/Exeup","commit_stats":null,"previous_names":["sectly/exeup"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Sectly/Exeup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sectly%2FExeup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sectly%2FExeup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sectly%2FExeup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sectly%2FExeup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sectly","download_url":"https://codeload.github.com/Sectly/Exeup/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sectly%2FExeup/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29333113,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T06:13:03.264Z","status":"ssl_error","status_checked_at":"2026-02-11T06:12:55.843Z","response_time":97,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["binary","build","bundle","compile","exe","exeup","node","windows"],"created_at":"2025-02-18T05:31:13.037Z","updated_at":"2026-02-11T12:40:03.509Z","avatar_url":"https://github.com/Sectly.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Exeup\n\nExeup: Pack up and bundle your Node.js project into a single .exe file for easy distribution and hassle-free execution on Windows!\n\n---\n\n## 📌 Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n  - [Using the CLI](#using-the-cli)\n  - [Using the npm Package](#using-the-npm-package)\n- [Configuration (CLI Only)](#configuration-cli-only)\n- [Options](#options)\n- [License](#license)\n\n---\n\n## 🚀 Installation\n\n### Install as a CLI Tool\n\nTo install Exeup globally, run:\n\n```sh\nnpm install -g exeup\n```\n\n### Install as a Developer Dependency\n\nTo use Exeup within a Node.js project:\n\n```sh\nnpm install -D exeup\n```\n\n---\n\n## 🔧 Usage\n\n### Using the CLI\n\nOnce installed, you can use the `exeup` command to package your Node.js project into an executable file.\n\n#### Initialize Configuration\n\nBefore building, configure Exeup by running:\n\n```sh\nexeup config\n```\n\nThis will prompt you for essential configuration details, such as the entry file, output path, version, and execution level.\n\n#### Build an Executable\n\nTo create an executable from your project:\n\n```sh\nexeup build\n```\n\n#### Check Version\n\nTo check the installed version of Exeup:\n\n```sh\nexeup version\n```\n\n#### View Help\n\nFor a list of available commands:\n\n```sh\nexeup help\n```\n\n---\n\n### Using the npm Package\n\nExeup can be used programmatically within your Node.js project.\n\n#### Example Usage\n\n```javascript\nconst exeup = require('exeup');\n\nconst options = {\n    entry: './index.js',\n    out: './build/myapp.exe',\n    version: '1.0.0',\n    icon: './assets/icon.ico',\n    skipBundle: false,\n    executionLevel: 'asInvoker',\n    properties: {\n        FileDescription: 'My Application',\n        ProductName: 'MyApp',\n        LegalCopyright: 'My Company',\n        OriginalFilename: 'myapp.exe',\n    }\n};\n\nexeup(options, (progressData) =\u003e {\n    console.log(`${progressData.progress}% - ${progressData.message}`);\n    if (progressData.done) {\n        console.log('Executable successfully created!');\n    }\n}).catch(console.error);\n```\n\n---\n\n## ⚙️ Configuration (CLI Only)\n\nThe CLI tool relies on a configuration file (`exeup.config.json`). You can generate this file using:\n\n```sh\nexeup config\n```\n\nExample `exeup.config.json`:\n\n```json\n{\n    \"entry\": \"./index.js\",\n    \"out\": \"./build/myapp.exe\",\n    \"version\": \"1.0.0\",\n    \"icon\": \"./assets/icon.ico\",\n    \"skipBundle\": false,\n    \"executionLevel\": \"asInvoker\",\n    \"properties\": {\n        \"FileDescription\": \"My Application\",\n        \"ProductName\": \"MyApp\",\n        \"LegalCopyright\": \"My Company\",\n        \"OriginalFilename\": \"myapp.exe\"\n    }\n}\n```\n\n---\n\n## ⚡ Options\n\n| Option              | Type    | CLI Only | Description                                                                                         |\n|---------------------|---------|----------|-----------------------------------------------------------------------------------------------------|\n| `entry`            | String  | No       | The entry file of your application.                                                                |\n| `out`              | String  | No       | The output file path for the generated executable.                                                 |\n| `version`          | String  | No       | The application version number.                                                                    |\n| `icon`             | String  | No       | The path to an `.ico` or `.png` file for the application icon.                                     |\n| `skipBundle`       | Boolean | No       | If `true`, skips the bundling process.                                                             |\n| `executionLevel`   | String  | No       | Sets execution privileges (`asInvoker`, `highestAvailable`, or `requireAdministrator`).            |\n| `properties`       | Object  | No       | Custom metadata (e.g., `FileDescription`, `ProductName`).                                          |\n| `exeup.config.json`| File    | Yes      | The CLI configuration file. Not required when using Exeup as a package.                           |\n\n---\n\n## 📜 License\n\nExeup is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\n\n---\n\n## 📂 Source Code\n\nFind the source code on GitHub: [Sectly/Exeup](https://github.com/Sectly/Exeup)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsectly%2Fexeup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsectly%2Fexeup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsectly%2Fexeup/lists"}