Installation #

Budo ships as a single command-line program, budo. You use it to create projects, run them on your desktop, export them to the web, and package them for Android.

Download the executable #

On macOS:

Terminal
# Download the budo binary for your system
curl -fL -o budo https://github.com/budo-platform/budo/releases/latest/download/budo-macos-aarch64

# Give it execution permission
chmod +x budo && ./budo help

On Linux:

Terminal
# Download the budo binary for your system
curl -fL -o budo https://github.com/budo-platform/budo/releases/latest/download/budo-linux-x86_64

# Give it execution permission
chmod +x budo && ./budo help

Make it globally accessible #

If you want to run Budo easily, you can copy it to your ~/.local/bin directory:

Terminal
mv budo ~/.local/bin/

If ~/.local/bin is not on your PATH, add this to your profile:

Terminal
# Make the commands in ~/.local/bin available in new terminals.
export PATH="$HOME/.local/bin:$PATH"

Now, you can run budo from any directory!

Open a new terminal and check that the command works:

Terminal
# Print the installed version and build details.
budo version

On Windows, you can download the latest budo-windows-x86_64.zip, extract it and run the budo.exe file from a terminal.

The budo command #

These are the commands you will use most:

Terminal
# Create a starter project in my-app/.
budo init my-app

# Run the project in a desktop window.
budo run my-app

# Run it, and restart it whenever a project file changes.
budo run my-app --watch

# Export a self-contained web build to dist/web.
budo web-export my-app

# Export the web build and serve it on http://localhost:8080.
budo web-serve my-app

# Build an Android APK (Budo Pro).
budo android-apk my-app

# Build an Android App Bundle for the Play Store (Budo Pro).
budo android-aab my-app

# Print the TypeScript declarations for the sys API.
budo budo.d.ts

# Print the full API reference as Markdown.
budo budo-llm.md

# List every command and option.
budo help

budo my-app is a shorthand for budo run my-app. You can also run a single source file without a project folder, as in budo sketch.js.

Android packaging is a Budo Pro feature, included for free in the released binaries during Budo's public launch; a later release will make it paid. Packaging and deployment covers web export, Android builds, and their options.

Next, build your first app in Getting started.