Skip to content

Latest commit

 

History

History
43 lines (36 loc) · 1.13 KB

README.md

File metadata and controls

43 lines (36 loc) · 1.13 KB

AsyncAPI logo
AsyncAPI CLI

CLI to work with your AsyncAPI files. Currently supports validation, but it is under development for more features.

Install

$ npm install --global @asyncapi/cli

CLI

$ asyncapi --help

Usage
  $ asyncapi command options
  
Commands
  validate 
   Options
     -c --context  context-name saved in the store
     -w --watch Enable watchMode (not implemented yet)
     -f --file File path of the specification file
  
  context
    current show the current set context
    list show the list of all stored contexts
    remove <context-name> remove a context from the store
    use <context-name> set any context from store as current
    add <context-name> <filepath> add/update new context

Examples
  $ asyncapi context add dummy ./asyncapi.yml
  $ asyncapi validate --context=dummy
  $ asyncapi validate --file=./asyncapi.yml

For now --context flag is requried to run validate command