playbooks

home / skills / a5c-ai / babysitter / neutralino-js-config

neutralino-js-config skill

/plugins/babysitter/skills/babysit/process/specializations/desktop-development/skills/neutralino-js-config

This skill helps you configure Neutralino.js for lightweight desktop apps, setting up projects, config files, and native API access for efficient

npx playbooks add skill a5c-ai/babysitter --skill neutralino-js-config

Review the files below or copy the command above to add this skill to your agents.

Files (2)
SKILL.md
1.3 KB
---
name: neutralino-js-config
description: Configure Neutralino.js for lightweight desktop applications
allowed-tools: Read, Write, Edit, Bash, Glob, Grep
tags: [neutralino, javascript, cross-platform, lightweight, desktop]
---

# neutralino-js-config

Configure Neutralino.js for lightweight desktop applications. Neutralino offers smaller binary sizes than Electron by using the OS's built-in webview.

## Capabilities

- Initialize Neutralino project
- Configure neutralino.config.json
- Set up native API access
- Configure window modes
- Set up extensions
- Configure build targets
- Set up app icons and metadata

## Input Schema

```json
{
  "type": "object",
  "properties": {
    "projectPath": { "type": "string" },
    "appName": { "type": "string" },
    "windowMode": { "enum": ["window", "browser", "cloud", "chrome"] }
  },
  "required": ["projectPath", "appName"]
}
```

## neutralino.config.json

```json
{
  "applicationId": "com.mycompany.myapp",
  "version": "1.0.0",
  "defaultMode": "window",
  "port": 0,
  "documentRoot": "/resources/",
  "url": "/",
  "enableServer": true,
  "enableNativeAPI": true,
  "modes": {
    "window": {
      "title": "My App",
      "width": 800,
      "height": 600,
      "minWidth": 400,
      "minHeight": 300
    }
  }
}
```

## Related Skills

- `tauri-project-setup`
- `electron-builder-config`

Overview

This skill configures Neutralino.js projects to build lightweight desktop applications that use the OS webview rather than bundling a full Chromium runtime. It automates neutralino.config.json generation, sets up native API access, window modes, build targets, and application metadata so you can ship smaller binaries with a familiar web stack. The goal is reproducible, minimal configuration that fits into agentic workflows and automated pipelines.

How this skill works

The skill inspects a target project path and generates or updates neutralino.config.json based on provided inputs like applicationId, version, defaultMode, and documentRoot. It can enable or disable the native API, configure window parameters (size, title, min dimensions), register extensions, and prepare platform-specific build targets and icons. When requested, it validates configuration values and emits actionable steps for packaging and local testing.

When to use it

  • Creating a new lightweight desktop app that prioritizes small binary size over bundled Chromium
  • Converting an existing web app into a Neutralino.js application for faster distribution
  • Automating neutralino.config.json generation inside CI/CD or agent-driven orchestration
  • Preparing platform-specific build targets and app metadata for cross-platform releases
  • Setting up native API access or custom extensions for desktop capabilities

Best practices

  • Keep documentRoot concise (only include necessary static assets) to reduce package size
  • Use explicit applicationId and version values to avoid build conflicts and enable updates
  • Choose window modes intentionally: use 'window' for classic desktop apps and 'browser' or 'chrome' for different UX constraints
  • Enable native API only when required and document any permissions or APIs used
  • Validate port and enableServer settings for automated test environments to avoid conflicts

Example use cases

  • Initialize neutralino.config.json for a new project with appName and projectPath supplied by an automation agent
  • Switch a production build to headless documentRoot and enableServer=false for snapshot testing
  • Configure multiple window modes and sizes for responsive desktop and kiosk deployments
  • Add platform-specific icons and metadata before invoking platform build tools in CI
  • Prepare a reproducible config for agents orchestrating packaging and release steps

FAQ

Can this skill enable native APIs selectively?

Yes — it can toggle enableNativeAPI and document required API permissions so native access is only granted when necessary.

Does it handle platform-specific builds and icons?

It prepares build target entries and metadata placeholders; you still invoke platform packaging tools, but the skill provides the correct neutralino configuration and asset placement guidance.