aayushmau5 / cli

(WIP) CLI to work with your AsyncAPI files. You can validate them, use generator and even bootstrap a new file.

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 🚇

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