CLI for bonsai, a lightweight 2D game framework written in Odin.

Note: Looking for the framework source code? Check out the main repository. For framework documentation, examples and tutorials, visit bonsai-framework.dev.

Prerequisites

Before using the CLI, ensure you have the following installed:

• Odin Compiler: Required to compile your game code.

  Ensure odin is in your system PATH.

• Git: Required to download templates and libraries.

For web builds:

• Emscripten SDK: Required to compile for the browser (WASM).

  Ensure emcc is in your system PATH.

Installation

If you have cargo installed, simply run:

cargo install bonsai-cli

Otherwise, you can install the binary via shell/powershell script:

On Linux/MacOS

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/nihiL7331/bonsai/releases/latest/download/bonsai-cli-installer.sh | sh

On Windows

powershell -ExecutionPolicy Bypass -c "irm https://github.com/nihiL7331/bonsai/releases/latest/download/bonsai-cli-installer.ps1 | iex"

Commands

The --verbose flag

Every bonsai command also accepts a verbose flag, which has to stand before the called command, e.g.:

bonsai --verbose build --web

bonsai init

Creates a new directory with the basic project structure.

Usage: bonsai init <name> [options]

Arguments:

• name: Project name.

Options:

• --dir: Target parent directory. (default: '.')
• --version: Version (branch) of the framework. (default: latest)

Example:

bonsai init pot

bonsai run

Runs a specified game project.

Usage: bonsai run [dir] [options] [flags]

Arguments:

• dir: Project root directory. (default: '.')

Options:

• --config: Mode in which the game is run (debug/release). (default: debug)
• --port: Port used to open a server for the web build. (default: 8080)

Flags:

• --desktop: Runs the game in the desktop environment.
• --web: Opens a server and runs the game in the web browser.
• --clean: Recompiles/rebuilds every element of the game.

If neither of desktop/web flags are selected, runs on desktop.

Example:

bonsai run --web --port 8000

bonsai build

Builds a bonsai project.

Usage: bonsai build [dir] [options] [flags]

Arguments:

• dir: Project root directory. (default: '.')

Options:

• --config: Mode in which the game is run (debug/release). (default: debug)

Flags:

• --desktop: Builds the game for the desktop platform.
• --web: Builds the game for the web platform.
• --clean: Recompiles/rebuild every element of the game.

If neither of desktop/web flags are selected, builds to desktop.

Example:

bonsai build my_project --clean

bonsai install

Installs a game system/module.

Usage: bonsai install <url> [options]

Arguments:

• url: URL to the desired systems repository. Accepts the full URL or a <username>/<repo_name> syntax.

Options:

• --version: Version (branch) of the system. (default: latest)
• --name: Directory name for the system. (default: repo_name)

Example:

bonsai install nihiL7331/tween

bonsai remove

Removes a game system/module.

Usage: bonsai remove <name> [flags]

Arguments:

• name: Name of the removed system.

Flags:

• --yes: Skips the 'Are you sure ...?' segment.

bonsai docs

Generates markdown reference docs of a project. Looks for '@overview' and '<trigger>' in the comments of a file. Generates markdown files using the comments and declarations below them. Creates a mirrored structure of the project. Supports procedures, enums, structures, constants, unions and function overloads.

This function isn't well polished at all, hence bugs may occur while using it.

Usage: bonsai docs <trigger> [options]

Arguments:

• trigger: A 'trigger' the CLI looks for in the comments of a file. Marks the beginning of a referenced object.

Options:

• --dir: Root directory of a project. (default: '.')
• --target: Target directory of generated documents. (default: '.')

Example:

bonsai docs @ref --target ../website/docs

The Project Manifest (bonsai.toml)

The CLI automatically manages your project configuration via a manifest file.

Features:

• Web Linking: the web_libs table allows for a quick way to link external C libraries required by Emscripten for web builds.
• Dependency Management: Systems can declare dependencies, which the CLI recursively resolves and installs from the systems repository.
• Version Locking: (WIP) Ensures lack of version conflicts by locking system versions.

Contributing

If you'd like to help build and expand the bonsai CLI, feel free to open an issue or PR!