#gamedev #firefly-zero #command-line-tool #cli

app firefly_cli

CLI tool for working with Firefly Zero

12 releases (4 breaking)

0.5.0 Oct 19, 2024
0.4.0 Aug 7, 2024
0.3.2 Jun 24, 2024
0.2.3 Jun 10, 2024
0.1.1 Apr 29, 2024

#340 in Game dev

Download history 117/week @ 2024-08-05 2/week @ 2024-08-12 25/week @ 2024-09-16 12/week @ 2024-09-23 6/week @ 2024-09-30 105/week @ 2024-10-14 26/week @ 2024-10-21 3/week @ 2024-10-28

134 downloads per month

MIT license

115KB
3K SLoC

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.

Dependencies

~22–37MB
~552K SLoC