@asyncapi/cli

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

Table of contents

• Installation
  • Using NPM and Node
  • MacOS
    • Using brew
    • Using pkg
• Usage
• Contributing
  • Set up development environment
  • Command Structure and Patterns
• Contributors

Installation

Using NPM and Node

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

Install the CLI globaly on your system run CLI it from anywhere:

npm install -g @asyncapi/cli

MacOS

Using brew

You can install this CLI using brew package manager.

# Install brew 
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
# Install AsyncAPI CLI
brew install asyncapi

Using pkg

Each release of CLI produces a MacOS dedicated pkg file that enables you to install this CLI as MacOS application.

# Download latest release. To download specific release, your link should look similar to https://github.com/asyncapi/cli/releases/download/v0.13.0/asyncapi.pkg. All releases are listed in https://github.com/asyncapi/cli/releases
curl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi.pkg
# Install AsyncAPI CLI
sudo installer -pkg asyncapi.pkg -target /

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
• Run npm run build and then bin/run to try new CLI locally

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 ⚠️

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