IO.CONNECT DESKTOP

Build a custom
desktop.

Use a seed project to configure io.Connect Desktop, add custom apps and branding, and build Windows or macOS installers.

Start building Read the docs
FROM SEED PROJECT TO INSTALLER
my-desktop
config/Settings
modifications/Branding
apps/Applications
package.jsonMetadata
Custom configuration, branding, and apps.
PREREQUISITESBefore you start.
RUNTIMENode.js 22.13+
PACKAGE MANAGERnpm 9+
YOUR MACHINEWindows 10+ / macOS 11+
Get Node.js

SETUP GUIDE

Create your custom build

Follow these five steps to set up, run, and package your desktop.

01

START HERE

Get your license key

Ask interop.io for a trial or use your existing io.Connect Desktop license. Have the key ready: the project wizard will ask for it.

Request a license Already have a key? Continue

The wizard saves it in config/iocd.license.key. Keep this file out of source control.

02

PROJECT SETUP

Create your seed project

Open a terminal in your projects folder and launch the interactive wizard.

Bash / projects folder
npx @interopio/iocd-cli@latest create

In the wizard

  • Choose a product name, such as My Desktop.
  • Create a new folder named my-desktop.
  • Select your components and any app templates you want to customize.
  • Paste your license key when prompted.

Enter that folder, install dependencies, and download the selected components.

Bash / install & prepare
cd my-desktop
npm install
npm run setup

Chose a different folder name? Use it in the cd command.

03

CUSTOMIZATION

Customize the project

The wizard has already set your product name and default description in package.json. Add your branding, configuration, and apps in these folders:

Branding & assetsmodifications/base/iocd/assets/ Configuration overridesmodifications/base/iocd/config/ Custom apps & templatesapps/

Use .json.merge files for configuration overrides. Keep changes under modifications/ so component updates preserve them.

Choose component versions in config/iocd.cli.config.json. Browse available components →

04

LOCAL DEVELOPMENT

Run your desktop locally

If you selected custom app templates, start their development servers first. Leave this terminal running.

Bash / terminal 1 · custom apps
npm run apps-dev

In another terminal, open the same project folder and launch the desktop. If you have no custom apps, run this command directly.

Bash / terminal 2 · my-desktop
npm run dev

Check your branding, configuration, and apps before packaging.

05

PACKAGING

Package your custom desktop

Close the development desktop, then build on the OS you’re packaging for: Windows for Windows, macOS for macOS.

Bash / my-desktop
npm run build
Find your packages in dist/make/

Depending on your configured makers: Windows Setup & ZIP, or macOS DMG & ZIP.

Before sharing, configure code signing in config/iocd.cli.config.json. Makers and publishers live in config/forge.config.js.