asyncapi/cli

CLI to work with your AsyncAPI files. Currently supports validation, but it is under development for more features.

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

Requirements

To run @asyncapi/cli, you'll need Node.js >=v10

Run this terminal command to check your Node.js version:

node -v

If you don't have Node.js installed or NPM, simply install both via package manager

Installation

Run this command to install the CLI globally on your system:

npm install -g @asyncapi/cli

This installs the cli globaly on your system allowing you to run it from anywhere. If you want to install it locally, just remove the -g flag.

Cli will be available for installation brew and other app managers for other systems.

Usage

As of now, the @asyncapi/cli only supports validation of the specification file. (This is still under development for more features.)

We have well-documented help commands so just run:

asyncapi --help

It should print something like:

All in one CLI for all AsyncAPI tools

USAGE
  $ asyncapi [COMMAND]

COMMANDS
  config    access configs
  diff      find diff between two asyncapi files
  new       creates a new asyncapi file
  start     starts a new local instance of Studio
  validate  validate asyncapi file

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.

UX developed for the CLI should be compliant with 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 goes 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 ⚠️