asyncapi/AsyncAPI CLI Action

One stop solution for all your AsyncAPI Specification needs in github actions.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Activelast commit Jul 11, 2026
License: Apache 2.0

Pinned Snippet

workflow.ymlSHA-pinned

uses: asyncapi/cli@fb73ff3a429c1bc6a14c1b89f12601288677b9fa # v6.0.2

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
cli_version	Version of AsyncAPI CLI to be used. This is only needed if you want to test with a specific version of AsyncAPI CLI. Default is latest which is also the recommended option.	no	""
command	Command to run. Available commands in action :- generate, validate, convert, optimize and custom. Default is generate. For custom command, provide the whole command as input. List of available commands can be found in https://www.asyncapi.com/docs/tools/cli/usage.	no	generate
filepath	Path to AsyncAPI document. This input is required if command is set to generate, validate, convert or optimize. Default is ./asyncapi.yaml	no	asyncapi.yml
template	Template for the generator. Official templates are listed here https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate. You can pass template as npm package, url to git repository, link to tar file or local template.	no	@asyncapi/markdown-template@2.0.0
language	Language of the generated code. This input is required if you want to generate models. List of available languages can be found in https://www.asyncapi.com/docs/tools/cli/usage#asyncapi-generate-models-language-file	no	""
output	Directory where to put the generated files. Can be used only with generate or convert commands. Default is output.	no	output
parameters	The command that you use might support and even require specific parameters to be passed to the CLI for the generation. Template parameters should be preceded by -p	no	""
custom_command	Custom command to be run. This input is required if command is set to custom.	no	""

Outputs

no outputs