https://github.com/flame-engine/ignite-cli
Simple CLI interface for Ignite; scaffold and setup your Flame projects with ease
https://github.com/flame-engine/ignite-cli
Last synced: 7 months ago
JSON representation
Simple CLI interface for Ignite; scaffold and setup your Flame projects with ease
- Host: GitHub
- URL: https://github.com/flame-engine/ignite-cli
- Owner: flame-engine
- License: mit
- Created: 2020-11-07T03:05:57.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-18T09:29:00.000Z (11 months ago)
- Last Synced: 2025-05-29T17:18:15.127Z (10 months ago)
- Language: Dart
- Size: 521 KB
- Stars: 19
- Watchers: 7
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pub.dartlang.org/packages/ignite_cli)
[](https://github.com/flame-engine/ignite-cli/actions)
[](https://discord.gg/pxrBmy4)
# ignite-cli
Simple CLI interface for Ignite; scaffold and setup your Flame projects with ease.
## Usage
Install it via pub (or build from src if you prefer the latest version):
```bash
flutter pub global activate ignite_cli
```
After you have added the bin folder to your path (the previous command will tell you what to add),
you can create a new project with Ignite, just run:
```bash
ignite create
```
And follow the instructions (this is called interactive mode - you might need a compatible shell for the interactive pickers to work).
Alternatively, you can set `--interactive=false` and manually specify all required options (error messages will be your friend):
```bash
ignite create --interactive=false --name=my_flame_game --org=org.flame-engine.example --create-folder=true --template=example
```
## Instructions for contributors
Run:
```bash
./scripts/test.sh
```
To run all tests. Always make sure the build is green.
You will need to install the bash testing framework [bats](https://bats-core.readthedocs.io/en/stable/installation.html).
In order to run the application locally, use:
```bash
dart bin/ignite_cli.dart
```
### Managing Templates
This project uses [package:mason](https://pub.dev/packages/mason) to manage and generate templates (bricks).
All supported bricks can be found in the [bricks](./bricks) directory.
Whenever a new brick is added or an existing brick is modified, make sure to regenerate the corresponding bundles via:
```bash
./scripts/build.sh
```
## Credits
This project was created with [Dart Stagehand](https://github.com/dart-lang/stagehand) and uses [Mason](https://pub.dev/packages/mason) for templating.