diff --git a/docs/usage.md b/docs/usage.md index 2bc42daf1a8..1902d14461a 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -3,45 +3,42 @@ title: 'Usage' weight: 40 --- -The AsyncAPI CLI makes it easier to work with AsyncAPI documents. + + +The AsyncAPI CLI makes it easier to work with AsyncAPI documents. -It should print something similar to this: -```sh -All in one CLI for all AsyncAPI tools +# Usage + +```sh-session +$ npm install -g @asyncapi/cli +$ asyncapi COMMAND +running command... +$ asyncapi (--version) +@asyncapi/cli/0.45.0 linux-x64 node-v18.16.0 +$ asyncapi --help [COMMAND] USAGE - $ asyncapi [COMMAND] - -TOPICS - config CLI config settings - generate Generate models and template - start Start AsyncAPI studio - -COMMANDS - config access configs - diff find diff between two AsyncAPI files - optimize optimizes your AsyncAPI file by removing unused components, re-using duplicates etc. - new creates a new AsyncAPI file - start starts a new local instance of Studio - validate validate an AsyncAPI file - generate generate all kinds of stuff - models generate all the typed models for the message payloads defined in the AsyncAPI file - typescript generate the models for TypeScript - csharp generate the models for C# - golang generate the models for Go - java generate the models for Java - javascript generate the models for JavaScript - dart generate the models for Dart - rust generate the models for Rust - kotlin generate the models for Kotlin - php generate the models for PHP - cplusplus generate the models for C++ - fromTemplate generate whatever you want using templates compatible with AsyncAPI Generator + $ asyncapi COMMAND +... ``` + + +# Commands + + + +