asyncapi/cli repository overview

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

⁠Table of contents

• Installation⁠
• Usage⁠
• Architecture⁠
• Debugging & Testing⁠
• Github Action⁠
• Contributing⁠
  • Set up development environment⁠
  • Command Structure and Patterns⁠
• Contributors⁠

⁠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.

⁠Debugging & Testing

The debugging & testing guide⁠ provides step-by-step instructions for debugging CLI commands, API endpoints, and services, along with comprehensive testing guidelines.

⁠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⁠):

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