@xsrg2008/electron-icon-builder

An icon generator that creates the assets commonly needed for Electron packaging.

Requirements

• Node.js 22+

Install

Global

# npm
npm install -g @xsrg2008/electron-icon-builder
# pnpm
pnpm add -g @xsrg2008/electron-icon-builder

Project local

# npm
npm install -D @xsrg2008/electron-icon-builder
# pnpm
pnpm add -D @xsrg2008/electron-icon-builder

Usage

CLI

# npx
npx xsrg2008-electron-icon-builder --input ./icon.png --output ./dist
# pnpm
pnpm exec xsrg2008-electron-icon-builder --input ./icon.png --output ./dist

Flatten the output structure when using tools that expect every icon in one directory:

# npx
npx xsrg2008-electron-icon-builder --input ./icon.png --output ./dist --flatten
# pnpm
pnpm exec xsrg2008-electron-icon-builder --input ./icon.png --output ./dist --flatten

Show the installed package version:

# npx
npx xsrg2008-electron-icon-builder --version
# pnpm
pnpm exec xsrg2008-electron-icon-builder --version

Programmatic API

const { buildIcons } = require("@xsrg2008/electron-icon-builder");

await buildIcons({
  input: "./icon.png",
  output: "./dist",
  flatten: false,
});

Arguments

--output, -o    Folder to create files in
--input, -i     Path to the source PNG file
--flatten, -f   Flatten the output structure
--version, -v   Show package version
--help, -h      Show usage information

Recommendations

Use a square PNG file that is at least 1024x1024. Smaller images will be upscaled, and non-square images will be stretched to fit the target icon sizes.

Origin

This is an independently maintained MIT-licensed fork of safu9/electron-icon-builder, not an official continuation of the original package.

Output structure

Default:

[output dir]
  icons/
    mac/
      icon.icns
    png/
      16x16.png
      24x24.png
      32x32.png
      48x48.png
      64x64.png
      128x128.png
      256x256.png
      512x512.png
      1024x1024.png
    win/
      icon.ico

With --flatten:

[output dir]
  icons/
    icon.icns
    icon.ico
    16x16.png
    24x24.png
    32x32.png
    48x48.png
    64x64.png
    128x128.png
    256x256.png
    512x512.png
    1024x1024.png

Development

This repository uses pnpm 10+ for local development and release checks.

pnpm install
pnpm check
pnpm format
pnpm test