install.md

Installation

As the CLI is currently an unofficial tool, it is not yet published to https://crates.io. It is available on Github, however.

You may compile the latest version of the CLI from scratch using cargo install:

cargo install --git https://github.com/TheBevyFlock/bevy_cli --tag cli-v0.1.0-alpha.2 --locked bevy_cli

Precompiled Binaries

The CLI is precompiled for Linux, Windows, and macOS. You may install the latest precompiled binary using cargo-binstall:

cargo binstall --git https://github.com/TheBevyFlock/bevy_cli --version 0.1.0-alpha.2 --locked bevy_cli

You can manually download the precompiled binaries from the release page.

Bleeding Edge

Here be dragons! 🐉

You may run into bugs when using the unstable version of the CLI. You've been warned, and have fun! :)

If you want to try out the newest unstable features, you may install the CLI from the main branch:

cargo install --git https://github.com/TheBevyFlock/bevy_cli --branch main --locked bevy_cli

Nix

Please note that Nix support is maintained on a best-effort basis, and therefore should not be considered stable. Features may be unavailable or break altogether as a result of future changes.

The CLI is available to Nix users as a flake. Simply add it as an input to your project's flake.nix to include it in the environment:

{
  description = "A Bevy project flake.";

  inputs = {
    # Other inputs...
    bevy_cli.url = "github:TheBevyFlock/bevy_cli";
  };

  outputs = { self, bevy_cli }: {
    # Your outputs...
  };
}

An example project flake can be found in the official Bevy docs.