@neutralinojs/neu

The official CLI of Neutralinojs. See neu CLI documentation for more details. Release notes are available at this page.

npm i -g @neutralinojs/neu

Requirements

• Node.js v12 or later version.
• npm, yarn, or any Node.js package manager.

License

MIT

Contributing to Neutralinojs

We really appreciate your code contributions. Please read this contribution guide before sending a pull request. Thank you for your contributions.

⚠️ Notice for contributors

Please note that we would like to keep this project's dependencies list minimal as possible. Make sure that you don't add new dependencies (external npm modules) with your pull requests. Also, don't use latest Node/JavaScript features that won't work on older Node.js versions. Thank you :tada:

Contributors

Made with contributors-img.

Changelog

v11.3.0

Host projects support

Developers can launch Neutralinojs from any programming language using child process APIs (i.e., subprocess in Python) and communicate with the framework process using the extension API. The new hostProject configuration object extends the official CLI to help developers easily create, run, and build these host projects. For example, the following host project configuration instructs the CLI to run a Node.js host project:

"hostProject": {
  "projectPath": "/node-src",
  "buildPath": "/node-src/dist/",
  "initCommand": "npm install",  
  "devCommand": "npm start",     
  "buildCommand": "npm run build"
}

Community projects implement bindings and templates to create host projects using Node.js, Python, Go, etc. For example, the node-neutralino NPM package lets you launch Neutralinojs via Node.js environments and execute native APIs via the NeutralinoApp class:

import NeutralinoApp from 'node-neutralino';

const app = new NeutralinoApp({
  url: '/',
  windowOptions: {
    enableInspector: false,
  }
});

app.init();
app.window.setTitle('Node.js');

Executable icon and metadata on Windows

Now, the neu build command automatically updates the executable file icon and metadata based on the following configuration options:

• author: gets written into executable's metadata.
• description: gets written into executable's metadata.
• copyright: gets written into executable's metadata. Defaults to current date + generic "all rights reserved".
• applicationName: gets written into executable's metadata. Defaults to cli.binaryName.
• applicationIcon: a relative path to an icon in .png format. Defaults to modes.window.icon. If it is not set, uses Neutralinojs logo.

Bugfixes/improvements

Use the zip-lib package to handle ZIP files for better performance and simplicity in the source code.