@asyncapi/cli
v2.8.1
Published
All in one CLI for all AsyncAPI tools
Downloads
84,748
Readme
CLI to work with your AsyncAPI files. Currently under development, we are working to bring more features.
Table of contents
Installation
Learn how to install the AsyncAPI CLI by following the instructions in the installation guide.
Usage
The usage guide provides information about different ways to use the CLI.
Contributing
Read CONTRIBUTING guide.
Set up development environment
Follow these steps:
- Clone the repo.
- Run
npm install
to install all the required dependencies - Run
npm run test
to make sure everything is properly set up - Run
npm run build
and thenbin/run
to try new CLI locally
The UX developed for the CLI should comply with the Command Line Interface Guideline
Command Structure and Patterns
We are following verb + noun
and namespace + noun + [verb]
pattern for making our commands and arguments. For example asyncapi validate <spec-file-path>
and asyncapi config context add <context-name> <spec-file-path>
.
Contributors
Thanks go to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!