Installation

🐚 CLI#

If you have cargo (the Rust package manager) installed, you can use it to install firefly-cli:

cargo install firefly_cli

If you don’t, install it from binary releases:

  1. Download the latest release. You need the one containing -linux- in the name. If you don’t know which one you need, it’s probably the one ending with -x86_64-unknown-linux-gnu.tar.gz.

  2. Make sure the ~/.local/bin directory is in your $PATH. Open ~/.bashrc (or ~/.zshrc if you use zsh) and add at the end the following:

    export PATH=$PATH:~/.local/bin

  3. Extract the binary and place it into your $PATH:

    cd ~/Downloads
tar -xvf ./firefly_cli-*.tar.gz
mv ./firefly_cli-*/firefly_cli ~/.local/bin
chmod +x ~/.local/bin/firefly_cli

  4. Verify installation:

    firefly_cli --version

  1. Download the latest release. You need the one ending with -x86_64-apple-darwin.tar.gz.

  2. Extract the files from the archive.

  3. Right-click on firefly_cli and select Open.
    If it doesn’t open, go to System Settings > Privacy & Security.
    Under Gatekeeper, a message should appear - press Open Anyway.

  4. Make sure the ~/.local/bin directory is in your $PATH.

    mkdir -p ~/.local/bin
echo 'export PATH="$PATH:$HOME/.local/bin"' >> ~/.zshrc
source ~/.zshrc

    (If you’re on macOS Catalina or older, or if you manually switched your shell to bash, use this instead:)

    echo 'export PATH="$PATH:$HOME/.local/bin"' >> ~/.bash_profile
source ~/.bash_profile

  5. Assuming the file is downloaded in your Downloads folder:

    cd ~/Downloads
tar -xvf ./firefly_cli-*.tar.gz
mv ./firefly_cli-*/firefly_cli ~/.local/bin
chmod +x ~/.local/bin/firefly_cli

  6. Verify the installation:

    firefly_cli --version

  1. Download the latest release. You need the one containing -windows- in the name. If you don’t know which one you need, it’s probably the one ending with -x86_64-pc-windows-msvc.zip.

  2. Extract files from the archive.

  3. Open the terminal and use the cd command to go to the directory containing firefly_cli.

  4. Verify intallation:

    firefly_cli --version

🚀 Launcher and games#

The firefly_cli import command can be used to install any app from the catalog. Start by installing the default launcher, multiplayer UI, and the snake game:

firefly_cli import sys.launcher
firefly_cli import sys.connector
firefly_cli import lux.snek

💻 Emulator#

  1. Download the latest release. You need the one ending with -x86_64-unknown-linux.tgz.gz.

  2. Make sure the ~/.local/bin directory is in your $PATH. Open ~/.bashrc (or ~/.zshrc if you use zsh) and add at the end the following:

    export PATH=$PATH:~/.local/bin

  3. Extract the binary and place it into your $PATH:

    cd ~/Downloads
tar -xvf ./firefly-emulator-*.tgz.gz
mv ./firefly-emulator ~/.local/bin
chmod +x ~/.local/bin/firefly-emulator

  4. Launch the emulator: firefly-emulator

  1. Download the latest release. You need the one ending with -x86_64-apple-darwin.tgz.
  2. Extract files from the archive.
  3. Right click on firefly_cli and press Open.
We don’t support Windows just yet. If you want to run the emulator on Windows, try running it in a Linux virtual machine.
Backward User 🎮 Emulator 💻 Forward