gem-hunter
Language: TypeScript
CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!
CLI to work with your AsyncAPI files. Currently under development, we are working to bring more features.
Learn how to install the AsyncAPI CLI by following the instructions in the installation guide.
The usage guide provides information about different ways to use the CLI.
The architecture guide provides information about the architecture. The bundler library lives in this repo at packages/bundler.
The debugging & testing guide provides step-by-step instructions for debugging CLI commands, API endpoints, and services, along with comprehensive testing guidelines.
The AsyncAPI CLI can be used as a GitHub Action. You can find more information in the GitHub Action guide.
Read CONTRIBUTING guide.
Read DEVELOPMENT.md file for development setup.
Additional steps:
npm run test to make sure everything is properly set upnpm run build and then bin/run to try new CLI locallyThis repository is an npm-workspaces + Turbo monorepo. The root package is
@asyncapi/cli(workspaces include"."so Changesets still versions it like today).@asyncapi/optimizerlives inpackages/optimizer/and@asyncapi/difflives inpackages/diff/. Both are published separately to npm. Usenpm run optimizer:build/npm run optimizer:testandnpm run diff:build/npm run diff:testto work on those packages. See their specs: optimizer, diff.
The UX developed for the CLI should comply with the Command Line Interface Guideline
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>.
Thanks go to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
