[📑 Docs]: add CLI docs to tools content bucket

[quetzalliwrites]

What Dev Docs changes are you proposing?

It's time to move our CLI readME docs to the website Docs, under the Tools content bucket: asyncapi.com/docs/tools.

CLI Docs Outline

Let's create the Docs with the following outline:

#Introduction 
## Installation
### MacOS
#### Using brew
#### Using pkg
### Linux
## Usage

Re-purpose content from CLI readME docs

Moving over the CLI docs to the website means re-writing and editing what's currently in the CLI readME docs. You should not be copy/pasting only.

Add Prev/Next buttons

Each new Docs page must add the Prev/Next buttons at the end of the page.

Code of Conduct

• [X] I agree to follow this project's Code of Conduct

[ro4i7]

Hello @alequetzalli

if this issue is still open, please assign it to me and give feedback on my below solution;

#Introduction to the AsyncAPI CLI

The AsyncAPI CLI is a command-line tool that helps you generate AsyncAPI documents, validate them, and perform other tasks related to AsyncAPI. This guide will walk you through the installation and usage of the AsyncAPI CLI.

Installation

The AsyncAPI CLI requires Node.js (v12 or newer) to be installed on your system before you can use it. You can download and install Node.js from the official website: https://nodejs.org/en/.

MacOS

Using Homebrew You can install the AsyncAPI CLI on macOS using Homebrew, a package manager for macOS:

brew tap asyncapi/asyncapi
brew install asyncapi

Using pkg Alternatively, you can download the pkg installer from the releases page on GitHub: https://github.com/asyncapi/asyncapi/releases/latest

Linux

To install the AsyncAPI CLI on Linux, you can use one of the following methods:

Using Homebrew You can install the AsyncAPI CLI on Linux using Homebrew, a package manager for Linux:

brew tap asyncapi/asyncapi
brew install asyncapi

Using the package manager You can also install the AsyncAPI CLI using your distribution's package manager. For example, on Debian/Ubuntu-based systems, you can use apt-get:

sudo apt-get install asyncapi

On Red Hat/Fedora-based systems, you can use dnf:

sudo dnf install asyncapi

Usage

The AsyncAPI CLI provides a number of commands for generating, validating, and manipulating AsyncAPI documents. Here are some common commands to get you started:

asyncapi init The asyncapi init command initializes a new AsyncAPI document in the current directory. You can specify the version of AsyncAPI you want to use by passing the --version flag:

asyncapi init --version 2.1.0

asyncapi validate The asyncapi validate command validates an AsyncAPI document against the AsyncAPI schema:

asyncapi validate asyncapi.yml

asyncapi bundle The asyncapi bundle command generates a new AsyncAPI document that includes all the external references (e.g., $ref) resolved:

asyncapi bundle asyncapi.yml -o bundled.yml

asyncapi docs The asyncapi docs command generates a static website with the documentation of the AsyncAPI document:

asyncapi docs asyncapi.yml -o docs/

For more information on the AsyncAPI CLI, please refer to the https://github.com/asyncapi/asyncapi/tree/master/cli.

That's it! You're now ready to use the AsyncAPI CLI to generate and work with AsyncAPI documents. Don't forget to add the Prev/Next buttons at the end of the page to navigate to the previous and next pages in the Tools section.

[quetzalliwrites]

Hey @ro4i7, this is already done by another contributor.

FYI, please don't spam an issue by copy/pasting your entire written content idea to the threads of comments. The appropriate way to submit a contribution idea is to open a PR with your contribution and then you can tag us to review or link to it in the issue.

[quetzalliwrites]

Aaaand speaking of CLI docs contributions... @derberg and @activus-d, where are we at with adding your merged CLI docs in cli repo to the actual docs website? I think an automation needs to be done or... what was it? 🤔

Realized we accidentally are forgetting to get these done too 😅

[activus-d]

@alequetzalli @derberg I will work on the automation this week. I'm adding it to the list of my set tasks right away.

[quetzalliwrites]

OMG THANK YOU SO MUCH, @activus-d! You rock ✨✨💪🏿

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart: