/cli

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!

Primary LanguageTypeScriptApache License 2.0Apache-2.0

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!