Get started

You can create and build a Buntralino application in minutes. Here's how:

0. Install Bun

If you haven't installed Bun into your system yet, you can do it with the following command:

Linux & macOS

curl -fsSL https://bun.sh/install | bash

Windows

powershell -c "irm bun.sh/install.ps1 | iex"

The same command can be used to update Bun. You may need to restart your terminal window if you're installing Bun for the first time.

1. Make a new Buntralino project

Instal the Buntralino CLI and create a Buntralino project:

New project

bun install -g buntralino-cli
buntralino create

Add to Neutralino.js project

# Run this in the root of your Neutralino.js project
bun install -g buntralino-cli
buntralino add

Are you getting could not determine executable to run for package errors?

There is an unresolved issue with bunx at this moment, but usually just removing the folder created by buntralino create and running the command again fixes the problem. Magic 🤷

2. Run the application

New project

cd buntralino-app
bun run dev

Add to Neutralino.js project

bun run dev

Possible issues on newer macOS and Linux devices

Various OS' security measures may disable the +x flag on Neutralino executables, marking them as non-executable. If you see permission or "executable not found" errors, it is probably because your system unmarked downloaded Neutralino binaries as executables. You can fix it by going to the created folder > bin folder and running chmod +x * there.

I've sent a PR to Neutralino.js so it auto-fixes the permissions, and this PR is now merged and will be released with the next Neutralino.js version.

3. Build the app

bun run build

That's it! Buntralino will build and package the app for distribution using neutralino.config.json Neutralino.js uses.