AsyncAPI CLI

Create, validate, and explore your AsyncAPI files with our CLI tool.

Installation & Usage

Start using AsyncAPI CLI within seconds by selecting one of our commands to get started.

Installing

1npm install -g @asyncapi/cli

Example

Create a new AsyncAPI file

1asyncapi new

Features

Use the AsyncAPI CLI tool to help you create, develop, and maintain your AsyncAPI files.

New files

Use the CLI tool to quickly create new AsyncAPI files. Select from a range of templates (MQTT, WebSockets, Kafka, and more.)

Validate

Validate your AsyncAPI documents with the CLI. Quickly get feedback to verify your AsyncAPI document is within the correct format.

Open Studio

Got an AsyncAPI file locally? Run asyncapi start studio to open our studio in seconds.

Open Source

All our tools are open source, feel free to contribute new commands or help evolve our existing ones.