Bevy CLI

A prototype Bevy CLI tool intended to streamline common tasks when working on projects. Please see the initial scope document and original issue for history and motivation.

• Documentation
• Repository
• Issue Tracker

If you need assistance or want to help, reach out to the bevy_cli working group channel in the Bevy Discord.

Installation

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

Precompiled Binary

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 --locked bevy_cli

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

Build from Source

You may compile the CLI from scratch using cargo install. To install the latest release, make sure to specify the version you wish in the tag (ex. --tag cli-v0.1.0).

cargo install --git https://github.com/TheBevyFlock/bevy_cli --tag cli-vX.Y.Z --locked bevy_cli

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

Quick Start

With the following steps, you can create a new 2D app with Bevy and run it in your browser:

1. Create a new Bevy app using the 2D template:

   bevy new -t=2d my_bevy_app

2. Navigate into the folder:

   cd my_bevy_app

3. Check the code quality with the linter:

   bevy lint

4. Run the app in the browser:

   bevy run web --open

License

The Bevy CLI is licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contributing

Please see CONTRIBUTING.md for more information!

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.