Package Exports
- @asyncapi/cli
- @asyncapi/cli/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@asyncapi/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
CLI to work with your AsyncAPI files. Currently under development, we are working to bring more features.
Table of contents
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 testto make sure everything is properly set up - Run
npm run buildand thenbin/runto 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!