Skip to content
/ cli Public

CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!

License

Notifications You must be signed in to change notification settings

asyncapi/cli

AsyncAPI CLI

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

GitHub license PR testing - if Node project npm

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 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
Jorge Aguiar Martín

💻 🤔 ⚠️ 📖
Lukasz Gornicki
Lukasz Gornicki

🤔 💻 👀 🚧
souvik
souvik

💻 🤔 ⚠️ 👀 🚧 📖
David Boyne
David Boyne

💻 🤔 🚧
Fran Méndez
Fran Méndez

💻 🤔 👀
Maciej Urbańczyk
Maciej Urbańczyk

👀 🚧 🤔
Aayush Kumar Sahu
Aayush Kumar Sahu

💻 ⚠️
Mihir Kulkarni
Mihir Kulkarni

💻
Abir
Abir

⚠️ 💻
Peter Ramos
Peter Ramos

💻
Samriddhi
Samriddhi

⚠️
Pranay Kharabe
Pranay Kharabe

💻
Damilola Oladele
Damilola Oladele

📖
Abhay Garg
Abhay Garg

💻 ⚠️
Sambhav Gupta
Sambhav Gupta

💻 ⚠️
Hippolyte Vergnol
Hippolyte Vergnol

💻 🚇
Jente Vets
Jente Vets

💻
Rishi
Rishi

💻
Ashish Padhy
Ashish Padhy

💻
Meet Agrawal
Meet Agrawal

🚇
Chinmay Shewale
Chinmay Shewale

💻 ⚠️
Mahfuza Humayra Mohona
Mahfuza Humayra Mohona

📖
Heiko Henning
Heiko Henning

💻
Zack_Aayush
Zack_Aayush

💻
Ayush Nautiyal
Ayush Nautiyal

💻
AnishKacham
AnishKacham

💻
Viacheslav Turovskyi
Viacheslav Turovskyi

💻
Amanpreet Singh Bedi
Amanpreet Singh Bedi

💻
Debajyoti Halder
Debajyoti Halder

💻
Savio Dias
Savio Dias

💻
Jonas Lagoni
Jonas Lagoni

💻 🤔 👀 ⚠️
Khuda Dad Nomani
Khuda Dad Nomani

💻 📖
Sergio Moya
Sergio Moya

💻
Vishal Sharma
Vishal Sharma

💻

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