Skip to main content
AsyncAPI Logo
Docs
Tools
Community
Case StudiesBlogRoadmap
Star on GitHub
  • Welcome
    • Concepts
      • Overview
        • Server
          • Producer
            • Consumer
              • Channel
                • Application
                  • Protocol
                    • Message
                    • Tutorials
                      • Overview
                        • Getting Started
                          • Introduction
                          • Event-Driven Architectures
                          • Coming from OpenAPI
                          • Hello world
                          • AsyncAPI documents
                          • Servers
                          • Adding security
                        • Create AsyncAPI document
                          • Generate code
                            • Validate AsyncAPI document with Studio
                              • Message validation in runtime
                                • Streetlights - Interactive (Alpha)
                                • Tools
                                  • Overview
                                    • Generator
                                      • Introduction
                                      • Installation guide
                                      • Usage
                                      • AsyncAPI document
                                      • Template
                                      • Parser
                                      • Generator version vs template version
                                      • Library API
                                      • Template development
                                      • Configuration file
                                      • Template context
                                      • React render engine
                                      • Nunjucks render engine
                                      • Hooks
                                      • File templates
                                      • TypeScript support
                                      • Special file names
                                    • CLI
                                      • Introduction
                                      • Installation guide
                                      • Usage
                                  • Guides
                                    • Overview
                                      • Validate AsyncAPI documents
                                        • Message validation
                                        • Reference
                                          • Overview
                                            • Specification
                                              • 3.0.0 (Pre-release)
                                              • 2.6.0
                                              • 2.5.0
                                              • 2.4.0
                                              • 2.3.0
                                              • 2.2.0
                                              • 2.1.0
                                              • 2.0.0

                                          Introduction

                                          Found an error? Have a suggestion?Edit this page on GitHub

                                          The AsyncAPI CLI is a tool you can use to work with your AsyncAPI documents. You can use the CLI to validate AsyncAPI documents, use the Generator tool, and even create new AsyncAPI documents.

                                          Go Back
                                          Tools - Special file names
                                          Up Next
                                          Installation guide
                                          Was this helpful?
                                          Help us improve the docs by adding your contribution.
                                          OR
                                          Github:AsyncAPICreate Issue on GitHub

                                          Building the future of
                                          Event-Driven Architectures.

                                          The Initiative

                                          • About
                                          • Blog
                                          • Shop
                                          • Jobs
                                          • Brand

                                          News

                                          • Email Us

                                          Social

                                          • Follow AsyncAPI on TwitterTwitter
                                          • AsyncAPI on GitHubGitHub
                                          • Follow AsyncAPI on LinkedInLinkedIn
                                          • Subscribe AsyncAPI on YouTubeYouTube
                                          • Join AsyncAPI on SlackSlack
                                          • Follow AsyncAPI on TwitchTwitch

                                          Made with :love: by the AsyncAPI Initiative.

                                          Copyright © AsyncAPI Project a Series of LF Projects, LLC. For web site terms of use, trademark policy and general project policies please see https://lfprojects.org

                                          Deploys by Netlify