@black-flag/demo

$ npx -p @black-flag/demo myctl --help

---

Black Flag CLI Demo

Black Flag is a yargs-based library for creating deeply hierarchical CLI tools declaratively and simply.

This repository corresponds to the usage tutorial featured in the Black Flag documentation.

If you want a more advanced example of a CLI written with Black Flag but with debug-based custom error handling and listr2 + inquirer output support, check out xunnctl.

Usage

For a more in-depth look, see the tutorial corresponding to this demo repository.

You don't need to install this demo to use it. You can invoke it directly:

npx -p @black-flag/demo myctl init --lang 'node' --version=21.1

And see pretty debug text like so:

DEBUG='*' npx -p @black-flag/demo myctl init --lang 'node' --version=21.1

If you do want to install the CLI for some reason, you should install it globally:

npm install -g @black-flag/demo

Either way, you can use the --help option to determine what the demo CLI can do:

npx -p @black-flag/demo myctl --help

Appendix 🏴

License

See LICENSE.

Contributing and Support

New issues and pull requests are always welcome and greatly appreciated! 🤩 Just as well, you can star 🌟 this project to let me know you found it useful! ✊🏿 Or you could buy me a beer 🥺 Thank you!

See CONTRIBUTING.md and SUPPORT.md for more information.

Contributors

Thanks goes to these wonderful people (emoji key):

Bernard 🚇 💻 📖 🚧 ⚠️ 👀

Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!