CLI to work with your AsyncAPI files. Currently supports validation, but it is under development for more features.
Table of contents
@asyncapi/cli, you'll need Node.js >=v10
Run this terminal command to check your Node.js version:
If you don't have Node.js installed or NPM, simply install both via package manager
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
Cli will be available for installation brew and other app managers for other systems.
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:
It should print something like:
All in one CLI for all AsyncAPI tools USAGE $ asyncapi [COMMAND] COMMANDS config access configs help display help for asyncapi new creates a new asyncapi file validate validate asyncapi file
Read CONTRIBUTING guide.
Set up development environment
Follow these steps:
- Clone the repo.
npm installto install all the required dependencies
npm run testto 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>.