Skip to main content
Installing macOS kernel extensions with electron-builder can be done using scripts that run during the installation process.

​
Configuration

First, configure your app to build a package (.pkg) instead of the default .dmg:
package.json
{
  "build": {
    "mac": {
      "target": "pkg"
    }
  }
}

​
Script Setup

Place your script and the kernel extensions in build/pkg-scripts, or define a custom directory.

​
Requirements

The script must be called either preinstall or postinstall
Use #!/bin/sh as the first line in your script
The script must be executable (chmod +x <filename>)

​
Example Script

Here’s an example postinstall script for managing kernel extensions:
build/pkg-scripts/postinstall
#!/bin/sh

echo "Unloading and uninstalling old extensions..."
# unload old extensions
sudo kextunload /Library/Extensions/myExt.kext

# delete old extensions
sudo rm -rf /Library/Extensions/myExtension.kext

# install new extensions
echo "Installing and loading new extensions..."
sudo cp -R myExt.kext /Library/Extensions/myExt.kext
sudo kextload /Library/Extensions/myExt.kext/

​
Making the Script Executable

Before building, ensure your script has execute permissions: 
chmod +x build/pkg-scripts/postinstall

​
Workflow

  1. Unload existing extensions - Use kextunload to unload any old versions
  2. Remove old files - Delete old extension files from /Library/Extensions/
  3. Copy new extensions - Copy your new .kext files to the system directory
  4. Load new extensions - Use kextload to activate the new extensions

​
Directory Structure

my-app/
├── build/
│   └── pkg-scripts/
│       ├── postinstall          # Your installation script
│       └── myExt.kext/          # Your kernel extension
├── package.json
└── ...

​
Custom Script Directory

To use a custom directory for your scripts, configure the scripts option: 
{
  "build": {
    "mac": {
      "target": "pkg"
    },
    "pkg": {
      "scripts": "custom/scripts/directory"
    }
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us