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

Repository files navigation

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

๐Ÿ’ป

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