firefly_cli

CLI tool for working with Firefly Zero


Keywords
gamedev, cli, firefly-zero, rust
License
MIT

Documentation

firefly-cli

[ 🐙 github ] [ 📦 crates.io ]

Swiss army knife CLI tool for working with Firefly Zero: build, upload, and publish apps, control device, etc.

📥 Installation

  • Grab the binary from the latest release and put it somewhere into $PATH.

  • Or install using cargo (the Rust package manager):

    cargo install firefly_cli
  • Or install dev version from the source:

    git clone --depth 1 https://github.com/firefly-zero/firefly-cli.git
    cd firefly-cli
    cargo install --path .

See the Installation page in the Firefly Zero docs for a more detailed guide.

🔧 Usage

# build an app and install it into VFS
firefly_cli build

# export an app installed in VFS
firefly_cli export --id sys.input-test

# install an exported app into VFS
firefly_cli import sys.input-test.zip

There are more commands. Most of them are covered in the dev docs. Specifically, in Getting Started and Debugging. Run firefly_cli --help to get the full list of available commands.