CLI to work with your AsyncAPI files. Currently under development, we are working to bring more features.

Table of contents

• Installation
• Usage
• Architecture
• Github Action
• Contributing
  • Set up development environment
  • Command Structure and Patterns
• Contributors
• 🚀 CI/CD Optimizations
  • Optimized Workflows

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.

Architecture

The architecture guide provides information about the architecture.

Github Action

The AsyncAPI CLI can be used as a GitHub Action. You can find more information in the GitHub Action guide.

Contributing

Read CONTRIBUTING guide.

Set up development environment

Read DEVELOPMENT.md file for development setup.

Additional steps:

• 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 🚇	Chinmay Shewale 💻 ⚠️
Mahfuza Humayra Mohona 📖	Heiko Henning 💻	Zack_Aayush 💻	Ayush Nautiyal 💻	AnishKacham 💻	Viacheslav Turovskyi 💻	Amanpreet Singh Bedi 💻
Debajyoti Halder 💻	Savio Dias 💻	Jonas Lagoni 💻 🤔 👀 ⚠️	Khuda Dad Nomani 💻 📖	Sergio Moya 💻	Vishal Sharma 💻

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

🚀 CI/CD Optimizations

This repository includes smart CI/CD optimizations to reduce unnecessary GitHub Actions runs when PR titles are changed multiple times. These optimizations:

• Reduce CI/CD load by ~70% for cosmetic title changes
• Preserve workflow functionality for meaningful changes
• Improve developer experience with faster feedback loops

Optimized Workflows

1. PR Title Linting - Skips re-validation for repeated title-only changes
2. Auto-Changeset Generation - Only runs when semantic prefixes change
3. Merge Label Management - Preserves labels for cosmetic title edits

📖 Read the full optimization details