Build a portable binary for Windows systems using Node's SEA. This project serves to and aid in automating bundling your source code with @vercel/ncc and modifying the executable properties post build with resedit-js.

Install this package and save to devDependencies using your package manager of choice.

npm i -D @angablue/exe

⚠️Warning⚠️: This package is only supported on Windows systems running Node v20.0.0 or newer. For older versions of Node (v12.0.0 or newer), please use the version v2.1.3 of this package

npm i -D @angablue/exe@2.1.3

Please note that the older version of this package is no longer maintained. Refer to the previous documentation here.

Point to a JSON configuration file to build your executable:

npx exe config-exe.json

Create a JSON configuration file with the following options:

{
    "entry": "index.js",
    "out": "My Cool App.exe",
    "skipBundle": false,
    "version": "package:version",
    "icon": "icon.ico",
    "executionLevel": "asInvoker",
    "properties": {
        "FileDescription": "My Cool App",
        "ProductName": "My Cool App",
        "LegalCopyright": "Copyright package:author.name",
        "OriginalFilename": "package:name"
    }
}

// build.js
const exe = require("@angablue/exe");

const build = exe({
  entry: "./index.js",
  out: "./build/My Cool App.exe",
});

build.then(() => console.log("Build completed!"));

@angablue/exe has first-class TypeScript support. You can use it in your TypeScript projects without any additional configuration.

Specify more arguments and completely customise the resultant executable.

// build.js
const exe = require("@angablue/exe");

const build = exe({
  entry: "./index.js",
  out: "./build/My Cool App.exe",
  skipBundle: false,
  version: "2.4.2",
  icon: "./assets/icon.ico", // Application icons must be in .ico format
  executionLevel: "asInvoker",
  properties: {
    FileDescription: "My Cool App",
    ProductName: "My Cool App",
    LegalCopyright: "AngaBlue https://anga.blue",
    OriginalFilename: "My Cool App.exe",
  },
});

build.then(() => console.log("Build completed!"));

• FileDescription: Description of the executable.
• ProductName: Name of the product.
• LegalCopyright: Copyright details with the URL.
• OriginalFilename: Name of the original file.

Give a ⭐️ if this project helped you!

Copyright © AngaBlue.
This project is LGPL--3.0--or--later licensed.