neutralinojs_skill

Overview

This skill helps developers build lightweight cross-platform desktop apps using Neutralino.js. It consolidates decision trees, API references, configuration guidance, and secure patterns so you can create small, native-feeling apps with JavaScript, HTML, and CSS. Use it to find the right API or configuration quickly and follow security best practices.

How this skill works

The skill organizes Neutralino.js knowledge into focused reference files and decision trees for common tasks (creating apps, window management, filesystem, OS operations, storage, events, extensions, building and distribution). It highlights critical runtime rules (initialize before using native APIs, handle window close, configure token security, and set allow/block lists) and provides example code patterns for file I/O, process management, and event handling. It points to the exact reference documents to read next for implementation details.

When to use it

• Building small desktop utilities that need filesystem or OS access
• Creating tray apps, system notifications, clipboard or system-info tools
• Running or spawning system commands and background processes
• Integrating web frontend frameworks (React/Vue) with native features
• Packaging and distributing compact cross-platform executables

Best practices

• Always create new projects with neu create unless explicitly asked to scaffold manually
• Call Neutralino.init() before any native API usage and register windowClose handlers
• Use @neutralinojs/lib for frontend frameworks instead of embedding neutralino.js directly
• Never use tokenSecurity: none; prefer one-time tokens and configure nativeAllowList/nativeBlockList
• Check and handle native API error codes (NE_FS_*, NE_OS_*, NE_RT_*) explicitly

Example use cases

• A tiny file manager or batch renamer that reads/writes files and watches directories
• A clipboard-history or quick notes utility with tray icon and notifications
• A lightweight launcher that executes commands and spawns background processes
• An offline web UI packaged as a native window using React and @neutralinojs/lib
• An auto-updating utility using the updater API and build/release options