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
# Then follow the instructions to input your project's name and template.

Add to Neutralino.js project

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

2. Run the application

New project

cd buntralino-app
bun run dev

Add to Neutralino.js project

bun run dev

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.