-
-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add instructions for using AsyncAPI CLI (#433)
- Loading branch information
1 parent
85e2626
commit 2130f97
Showing
1 changed file
with
9 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,22 +18,27 @@ HTML template for the [AsyncAPI Generator](https://github.com/asyncapi/generator | |
- [Usage](#usage) | ||
- [Supported parameters](#supported-parameters) | ||
- [Development](#development) | ||
- [Contributors ✨](#contributors-%E2%9C%A8) | ||
- [Contributors ✨](#contributors-) | ||
|
||
<!-- tocstop --> | ||
|
||
## Usage | ||
|
||
Install AsyncAPI CLI | ||
|
||
```bash | ||
ag asyncapi.yaml @asyncapi/html-template -o output | ||
npm install -g @asyncapi/cli | ||
``` | ||
|
||
If you don't have the AsyncAPI Generator installed, you can install it like this: | ||
Generate using CLI | ||
|
||
```bash | ||
npm install -g @asyncapi/generator | ||
asyncapi generate fromTemplate <asyncapi.yaml> @asyncapi/[email protected] | ||
``` | ||
|
||
You can replace `<asyncapi.yaml>` with local path or URL pointing to [any AsyncAPI document](https://raw.githubusercontent.com/asyncapi/spec/master/examples/streetlights-kafka.yml). | ||
Look into [Releases](/asyncapi/html-template/releases) of this template to pick up the version you need. It is not recommended to always use the latest in production. Always use a specific version. | ||
|
||
## Supported parameters | ||
|
||
| Name | Description | Required | Default | Allowed values | Example | | ||
|