CLI to work with your AsyncAPI files. Currently under development, we are working to bring more features.

Table of contents

Installation
Usage
Contributing
- Set up development environment
- Command Structure and Patterns
Contributors

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 then bin/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):

_{Jorge Aguiar Martín} 💻 🤔 ⚠️ 📖	_{Lukasz Gornicki} 🤔 💻 👀 🚧	_souvik 💻 🤔 ⚠️ 👀 🚧 📖	_{David Boyne} 💻 🤔 🚧	_{Fran Méndez} 💻 🤔 👀	_{Maciej Urbańczyk} 👀 🚧 🤔	_{Aayush Kumar Sahu} 💻 ⚠️
_{Mihir Kulkarni} 💻	_Abir ⚠️ 💻	_{Peter Ramos} 💻	_Samriddhi ⚠️	_{Pranay Kharabe} 💻	_{Damilola Oladele} 📖	_{Abhay Garg} 💻 ⚠️
_{Sambhav Gupta} 💻 ⚠️	_{Hippolyte Vergnol} 💻 🚇	_{Jente Vets} 💻	_Rishi 💻	_{Ashish Padhy} 💻	_{Meet Agrawal} 🚇	_{Chinmay Shewale} 💻 ⚠️
_{Mahfuza Humayra Mohona} 📖	_{Heiko Henning} 💻	_{Zack_Aayush} 💻	_{Ayush Nautiyal} 💻	_AnishKacham 💻	_{Viacheslav Turovskyi} 💻	_{Amanpreet Singh Bedi} 💻
_{Debajyoti Halder} 💻	_{Savio Dias} 💻	_{Jonas Lagoni} 🤔💻⚠️	_{Khuda Dad Nomani} 💻📖	_{Sergio Moya} 💻

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

License

asyncapi/cli

About

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases 288

Sponsor this project

Contributors 48

Languages