Installation #

The easiest way to make the budo command available on your system is to use the Budo installer script. No root, no shell profile edits. It installs the unique command line binary to ~/.local/bin/budo.

You can also use alternative methods or build Budo from the sources.

Terminal
curl -fsSL https://budo-platform.dev/install.sh | bash

Now you can use the installed CLI for mainly three things: run your application on your desktop, create an Android application file and export your application to the web.

The Budo command line #

The main Budo CLI commands are:

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

# Run a project directory explicitly.
budo run my-app

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

# Export and serve locally for browser testing.
budo web-serve my-app

# Build an Android APK release.
budo android-apk my-app --release

# Build an Android App Bundle release.
budo android-aab my-app --release

# Print the TypeScript declarations bundled with the runtime.
budo budo.d.ts

# Print the generated developer API reference.
budo budo-llm.md

# Show the command help.
budo help

Note that the shorthand budo my-app is accepted for run.