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:

🐧 Linux

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.
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
```

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

🍏 OS X

Download the latest release. You need the one ending with -x86_64-apple-darwin.tar.gz.
Extract files from the archive.
Right click on firefly_cli and press Open. This will make the binary trusted.
Open the terminal and use the cd command to go to the directory containing firefly_cli.
Verify intallation:
```
./firefly_cli --version
```

🪟 Windows

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.
Extract files from the archive.
Open the terminal and use the cd command to go to the directory containing firefly_cli.
Verify intallation:
```
firefly_cli --version
```

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

firefly_cli import sys.launcher
firefly_cli import lux.snek

🐧 Linux

Download the latest release. You need the one ending with -x86_64-unknown-linux.tgz.gz.
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
```

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

🍏 OS X

Download the latest release. You need the one ending with -x86_64-apple-darwin.tgz.
Extract files from the archive.
Right click on firefly_cli and press Open.

🪟 Windows

We don’t support Windows just yet. If you want to run the emulator on Windows, try running it in a Linux virtual machine.