asyncapi · asyncapi-bot · Nov 14, 2022 · Jul 20, 2022 · Sep 26, 2022 · Sep 26, 2022
@@ -66,163 +66,16 @@ You can find above templates and the ones provided by the community in **[this l
 
 Install both packages using [official installer](https://nodejs.org/en/download/). After installation make sure both packages have proper version by running `node -v` and `npm -v`. To upgrade invalid npm version run `npm install npm@latest -g`
 
-> Generator is tested at the moment against Node 14 and NPM 6. Using newer versions is enabled but we do not guarantee they work well. Please provide feedback on the issues.
+> The generator is tested at the moment against Node 14 and NPM 6. Using newer versions is enabled but we don't guarantee they work well. Please provide feedback via issues.
 
 ## Using from the command-line interface (CLI)
 
 ### CLI installation
 Learn to install the AsyncAPI CLI from the [installation guide](installation-guide.md).
 
-### CLI usage
-
-```bash
-Usage: ag [options] <asyncapi> <template>
-
-- <asyncapi>: Local path or URL pointing to AsyncAPI specification file
-- <template>: Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template
-
-Options:
-  -V, --version                  output the version number
-  -d, --disable-hook [hooks...]  disable a specific hook type or hooks from given hook type
-  --debug                        enable more specific errors in the console
-  -i, --install                  installs the template and its dependencies (defaults to false)
-  -n, --no-overwrite <glob>      glob or path of the file(s) to skip when regenerating
-  -o, --output <outputDir>       directory where to put the generated files (defaults to current directory)
-  -p, --param <name=value>       additional param to pass to templates
-  --force-write                  force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)
-  --watch-template               watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory. This flag should be used only for template development.
-  --map-base-url <url:folder>    maps all schema references from base url to local folder
-  -h, --help                     display help for command
-```
-
-<details>
-  <summary>Click here to read more about supported values for the <code>&lt;template&gt;</code> parameter.</summary>
-  <br>
-  Templates are installable npm packages. Therefore, the value of <code>&lt;template&gt;</code> can be anything supported by <code>npm install</code>. Here's a summary of the possibilities:
-  <br><br>
-  <pre><code>
-  npm install [&lt;@scope&gt;/]&lt;name&gt;
-  npm install [&lt;@scope&gt;/]&lt;name&gt;@&lt;tag&gt;
-  npm install [&lt;@scope&gt;/]&lt;name&gt;@&lt;version&gt;
-  npm install [&lt;@scope&gt;/]&lt;name&gt;@&lt;version range&gt;
-  npm install &lt;git-host&gt;:&lt;git-user&gt;/&lt;repo-name&gt;
-  npm install &lt;git repo url&gt;
-  npm install &lt;tarball file&gt;
-  npm install &lt;tarball url&gt;
-  npm install &lt;folder&gt;</code></pre>
-</details>
-<br>
-
-### Global templates installed with yarn or npm
+### CLI usage 
 
-You can preinstall templates globally. The generator first tries to locate template in local dependencies and then in location where global packages are installed.
-
-```bash
-npm install -g @asyncapi/html-template@0.16.0
-ag asyncapi.yaml @asyncapi/html-template
-# The generator uses template in version 0.16.0 and not latest
-```
-
-### CLI usage examples
-
-**The shortest possible syntax:**
-```bash
-ag asyncapi.yaml @asyncapi/html-template
-```
-
-**Generating from a URL:**
-```bash
-ag https://bit.ly/asyncapi @asyncapi/html-template
-```
-
-**Specify where to put the result:**
-```bash
-ag asyncapi.yaml @asyncapi/html-template -o ./docs
-```
-
-**Passing parameters to templates:**
-```bash
-ag asyncapi.yaml @asyncapi/html-template -o ./docs -p title='Hello from param'
-```
-
-In the template you can use it like this: ` {{ params.title }}`
-
-**Disabling the hooks:**
-```bash
-ag asyncapi.yaml @asyncapi/html-template -o ./docs -d generate:before generate:after=foo,bar
-```
-
-The generator skips all hooks of the `generate:before` type and `foo`, `bar` hooks of the `generate:after` type.
-
-**Installing the template from a folder:**
-```bash
-ag asyncapi.yaml ~/my-template
-```
-
-It creates a symbolic link to the target directory (`~/my-template` in this case).
-
-**Installing the template from a git URL:**
-```bash
-ag asyncapi.yaml https://github.com/asyncapi/html-template.git
-```
-
-**Map schema references from baseUrl to local folder:**
-```bash
-ag test/docs/apiwithref.json @asyncapi/html-template -o ./build/ --force-write --map-base-url https://schema.example.com/crm/:./test/docs/
-```
-
-The parameter `--map-base-url` maps external schema references to local folders.
-
-### CLI usage with Docker
-
-Install [Docker](https://docs.docker.com/get-docker/) first. Thanks to Docker you do not need Node.js even though the generator is written with it.
-
-```bash
-docker run --rm -it \
--v [ASYNCAPI SPEC FILE LOCATION]:/app/asyncapi.yml \
--v [GENERATED FILES LOCATION]:/app/output \
-asyncapi/generator [COMMAND HERE]
-
-# Example that you can run inside generator directory after cloning this repository. First you specify mount in location of your AsyncAPI specification file and then you mount in directory where generation result should be saved.
-docker run --rm -it \
--v ${PWD}/test/docs/dummy.yml:/app/asyncapi.yml \
--v ${PWD}/output:/app/output \
-asyncapi/generator -o /app/output /app/asyncapi.yml @asyncapi/html-template --force-write
-```
-
-### CLI usage with npx instead of npm
-
-The [npx](https://www.npmjs.com/package/npx) is very useful when you want to run Generator in CI/CD environment. In such a scenario, you do not want to install generator globally and most environments that provide Node.js and npm, also provide npx out of the box.
-
-```bash
-npx -p @asyncapi/generator ag ./asyncapi.yaml @asyncapi/html-template
-```
-
-## Using as a module/package
-
-### Install the module
-
-```bash
-npm install @asyncapi/generator --save
-```
-
-### Example using the module 
-
-Below you can find an example of HTML generation using official `@asyncapi/html-template` template and fetching the spec document from server like `https://raw.githubusercontent.com/asyncapi/asyncapi/2.0.0/examples/2.0.0/streetlights.yml` :
-
-```js
-const path = require('path');
-const generator = new Generator('@asyncapi/html-template', path.resolve(__dirname, 'example'));
-
-try {
-  await generator.generateFromURL('https://raw.githubusercontent.com/asyncapi/asyncapi/2.0.0/examples/2.0.0/streetlights.yml');
-  console.log('Done!');
-} catch (e) {
-  console.error(e);
-}
-```
-
-See [API documentation](docs/api.md) for more example and full API reference information.
+Learn more about different ways of using the CLI from the [usage document](usage.md).
 
 ## Generator version vs Template version
 

@@ -0,0 +1,153 @@
+---
+title: "Usage"
+weight: 30
+---
+
+There are two ways to use the generator:
+- [Generator CLI](#generator-cli)
+- [Generator library](#generator-library)
+
+## Generator CLI
+```bash
+Usage: asyncapi generate fromTemplate <asyncapi> <template> [<options>]
+
+- <asyncapi>: Local path or URL pointing to AsyncAPI document for example https://bit.ly/asyncapi
+- <template>: Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template
+
+- <options>:
+  -V, --version                  output the generator version
+  -d, --disable-hook [hooks...]  disable a specific hook type or hooks from a given hook type
+  --debug                        enable more specific errors in the console
+  -i, --install                  install the template and its dependencies (defaults to false)
+  -n, --no-overwrite <glob>      glob or path of the file(s) to skip when regenerating
+  -o, --output <outputDir>       directory to put the generated files (defaults to current directory)
+  -p, --param <name=value>       additional parameters to pass to templates
+  --force-write                  force writing of the generated files to a given directory even if it is a Git repository with unstaged files or not empty dir (defaults to false)
+  --watch-template               watches the template directory and the AsyncAPI document, and re-generates the files when changes occur. Ignores the output directory. This flag should be used only for template development.
+  --map-base-url <url:folder>    maps all schema references from base URL to local folder
+  -h, --help                     display help for command
+```
+
+<details>
+  <summary>Click here to read more about supported values for the <code>&lt;template&gt;</code> parameter.</summary>
+  <br>
+  All templates are installable npm packages. Therefore, the value of <code>&lt;template&gt;</code> can be anything supported by <code>npm install</code>. Here's a summary of the possibilities:
+  <br><br>
+  <pre><code>
+  npm install [&lt;@scope&gt;/]&lt;name&gt;
+  npm install [&lt;@scope&gt;/]&lt;name&gt;@&lt;tag&gt;
+  npm install [&lt;@scope&gt;/]&lt;name&gt;@&lt;version&gt;
+  npm install [&lt;@scope&gt;/]&lt;name&gt;@&lt;version range&gt;
+  npm install &lt;git-host&gt;:&lt;git-user&gt;/&lt;repo-name&gt;
+  npm install &lt;git repo url&gt;
+  npm install &lt;tarball file&gt;
+  npm install &lt;tarball url&gt;
+  npm install &lt;folder&gt;</code></pre>
+</details>
+<br>
+
+### Global templates installed with `yarn` or `npm`
+
+You can preinstall templates globally before installing the generator CLI. The generator first tries to locate the template in local dependencies; if absent it checks where the global generator packages are installed.
+
+```bash
+npm install -g @asyncapi/html-template@0.16.0
+asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template
+# The generator uses html-template version 0.16.0 and not the latest version.
+```
+
+### CLI usage examples
+
+**The shortest possible syntax:**
+```bash
+asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template
+```
+
+**Generating from a URL:**
+```bash
+asyncapi generate fromTemplate https://bit.ly/asyncapi @asyncapi/html-template
+```
+
+**Specify where to put the result:**
+```bash
+asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template -o ./docs
+```
+
+**Passing parameters to templates:**
+```bash
+asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template -o ./docs -p title='Hello from param'
+```
+
+In the template you can use it like this: ` {{ params.title }}`
+
+**Disabling the hooks:**
+```bash
+asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template -o ./docs -d generate:before generate:after=foo,bar
+```
+
+The generator skips all hooks of the `generate:before` type and `foo`, `bar` hooks of the `generate:after` type.
+
+**Installing the template from a folder:**
+```bash
+asyncapi generate fromTemplate asyncapi.yaml ~/my-template
+```
+
+It creates a symbolic link to the target directory (`~/my-template` in this case).
+
+**Installing the template from a git URL:**
+```bash
+asyncapi generate fromTemplate asyncapi.yaml https://github.com/asyncapi/html-template.git
+```
+
+**Map schema references from baseUrl to local folder:**
+```bash
+asyncapi generate fromTemplate test/docs/apiwithref.json @asyncapi/html-template -o ./build/ --force-write --map-base-url https://schema.example.com/crm/:./test/docs/
+```
+
+The parameter `--map-base-url` maps external schema references to local folders.
+
+### CLI usage with Docker
+
+When using our docker image that we regularly update, you don't need to install Node.js or Npm, even though the generator is written with it since the Docker image has the generator installed.
+
+Install [Docker](https://docs.docker.com/get-docker/) first, then use docker to pull and run the image using the following command:
+
+```bash
+docker run --rm -it \
+-v [ASYNCAPI SPEC FILE LOCATION]:/app/asyncapi.yml \
+-v [GENERATED FILES LOCATION]:/app/output \
+asyncapi/generator [COMMAND HERE]
+
+# Example that you can run inside the generator directory after cloning this repository. First, you specify the mount in the location of your AsyncAPI specification file and then you mount it in the directory where the generation result should be saved.
+docker run --rm -it \
+-v ${PWD}/test/docs/dummy.yml:/app/asyncapi.yml \
+-v ${PWD}/output:/app/output \
+asyncapi/generator -o /app/output /app/asyncapi.yml @asyncapi/html-template --force-write
+```
+
+### CLI usage with `npx` instead of `npm`
+
+[npx](https://www.npmjs.com/package/npx) is very useful when you want to run the generator in a CI/CD environment. In such a scenario, do not install the generator globally because most environments that provide Node.js and Npm, also provide npx out of the box. 
+
+Use the following npx command on your terminal:
+
+```bash
+npx -p @asyncapi/cli asyncapi generate fromTemplate ./asyncapi.yaml @asyncapi/html-template
+```
+
+## Using as a module/package
+Once you install the generator in your project, you can use it to generate whatever you want. The following code snippet is an example of HTML generation using the official `@asyncapi/html-template` template and fetching the spec document from the server using `https://raw.githubusercontent.com/asyncapi/asyncapi/2.0.0/examples/2.0.0/streetlights.yml`:
+
+```js
+const path = require('path');
+const generator = new Generator('@asyncapi/html-template', path.resolve(__dirname, 'example'));
+
+try {
+  await generator.generateFromURL('https://raw.githubusercontent.com/asyncapi/asyncapi/2.0.0/examples/2.0.0/streetlights.yml');
+  console.log('Done!');
+} catch (e) {
+  console.error(e);
+}
+```
+
+See the [API documentation](api.md) for more examples and full API reference information.