> Markdown version of https://www.asyncapi.com/docs/tools/cli/installation > Index: https://www.asyncapi.com/llms.txt # Installation guide ## Node and npm To use the AsyncAPI CLI tool, you must install NPM and Node.js version 16 or higher. To check if you already have both installed, run the following commands in your terminal: ```sh # check if node is installed node -v # or node --version # check if NPM is installed npm -v # or npm --version ``` If you don’t have Node.js or NPM installed, you can install both with this [Node.js package manager](https://nodejs.org/en/download/package-manager/). After installing Node.js and NPM, run the following command to install the AsyncAPI ClI globally: ```sh npm install -g @asyncapi/cli ``` > [!NOTE] > AsyncAPI Studio is not bundled with the CLI to keep the install small. The first time you run `asyncapi start studio`, `asyncapi start preview`, or `asyncapi new --studio`, the CLI will ask to download Studio (~450MB) into its data directory. To download it ahead of time, run `asyncapi studio install` (or `asyncapi studio install --yes` without a prompt). In non-interactive environments (like CI), pass `--yes` or set `ASYNCAPI_STUDIO_AUTO_INSTALL=1`. > [!IMPORTANT] > Standalone `.exe`, `.pkg`, `.deb`, and archive installations do not bundle npm. All non-Studio CLI commands work without npm, but installing Studio on-demand requires npm on `PATH`. If the CLI reports that npm is unavailable, install Node.js and npm from [nodejs.org](https://nodejs.org/) and rerun `asyncapi studio install --yes`. To enable the autocomplete feature in the CLI for the shells **bash and zshrc**, there is a script that will run automatically and autocomplete is only support for **bash and zshrc** for the **powershell** refer to manually enabling [autocomplete](https://www.asyncapi.com/docs/tools/cli/autocompleteEnabled) guide in ClI: After the ClI installation : if the configuration is not present logs will be: ```sh ✅ Autocomplete configuration added to .zshrc. ``` If the configuration is present for autocomplete logs: ```sh ✅ Autocomplete is already configured. Skipping addition. ``` To refresh the variables: ```sh source ~/.bashrc # For bash source ~/.zshrc # For zsh ``` ## Docker Install [Docker](https://docs.docker.com/get-docker/) first, then use docker to build the image using the following command : ``` docker build -t asyncapi/cli:latest . ``` and run the image using the following command : ```bash docker run --rm -it \ --user=root \ -v [ASYNCAPI SPEC FILE LOCATION]:/app/asyncapi.yml \ -v [GENERATED FILES LOCATION]:/app/output \ asyncapi/cli [COMMAND HERE] # Example that you can run inside the cli 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 \ --user=root \ -v ${PWD}/test/integration/fixtures/asyncapi_v1.yml:/app/asyncapi.yml \ -v ${PWD}/output:/app/output \ asyncapi/cli generate fromTemplate -o /app/output /app/asyncapi.yml @asyncapi/html-template --force-write ``` Note: Use ``` ` ``` instead of `\` for Windows. > [!NOTE] > The Docker image keeps chromium (so PDF generation with `@asyncapi/html-template` works out of the box) but does not bundle AsyncAPI Studio. Running `asyncapi start studio`/`start preview` inside the container will offer to install Studio on-demand; pass `--yes` (or set `ASYNCAPI_STUDIO_AUTO_INSTALL=1`) to install it without a prompt. Note that Studio starts a local web server, so you also need to publish the port (e.g. `-p 3210:3210`) to reach it from your host. ## Mac There are two ways to install the AsyncAPI CLI on your macOS: using the `brew` package manager or `pkg` files. ### brew To install the AsyncAPI CLI using the `brew` package manager, run the following commands in your terminal: ```sh # Install brew /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" # Install AsyncAPI CLI brew install asyncapi ``` ### pkg Every release of the AsyncAPI CLI has two macOS dedicated `pkg` file that enables you to install the CLI tool as a macOS application for x64 as well as arm64 architecture. To download the latest CLI release, run this command in your terminal: ```sh # For x64 curl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi.x64.pkg # For arm64 curl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi.arm64.pkg ``` To download a specific CLI release, run this command in your terminal: ```sh curl -OL https://github.com/asyncapi/cli/releases/download//asyncapi.pkg ``` > **Remember** > > Follow this link for all AsyncAPI CLI releases. After downloading the AsyncAPI CLI, install it via the following command: ```sh sudo installer -pkg asyncapi.pkg -target / ``` ## Windows There are two ways to install the AsyncAPI CLI on your Windows operating system: using the `chocolatey` package manager or executable files. ### Chocolatey Prerequisites: [Chocolatey](https://chocolatey.org/install) must be installed on your Windows operating system. The installation instructions can be found [here](https://docs.chocolatey.org/en-us/choco/setup#installing-chocolatey-cli). To install the AsyncAPI CLI using the `chocolatey` package manager, run the following command in your terminal with administrator privileges: ```sh # Install AsyncAPI CLI choco install asyncapi ``` To upgrade run this command:- ```sh # Upgrade AsyncAPI CLI choco upgrade asyncapi ``` To install a specific version run this command: ```sh # Install AsyncAPI CLI version xx.xx.xx choco install asyncapi --version xx.xx.xx ``` All the AsyncAPI CLI versions can be found [here](https://chocolatey.org/packages/asyncapi). ### Executable files Just install the appropriate installer and simply follow the default installation steps to complete the installation process. Download [asyncapi.x64.exe](https://github.com/asyncapi/cli/releases/latest/download/asyncapi.x64.exe) for 64-bit Windows and download [asyncapi.x86.exe](https://github.com/asyncapi/cli/releases/latest/download/asyncapi.x86.exe) for 32-bit Windows. ## Linux Selecting the appropriate AsyncAPI CLI installation method on a Linux operating system depends on your Linux distro. ### Debian based distros For Debian based distros, you can install the AsycAPI CLI using the `dpkg` package manager for Debian. ```sh curl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi.deb ``` To download a specific release of the CLI, run this command in your terminal: ```sh curl -OL https://github.com/asyncapi/cli/releases/download//asyncapi.deb ``` ### Other distros You can install the AsyncAPI CLI for other Linux distros using the archive `tar.gz` file. #### For Alpine Linux / musl-based systems: To download the latest Alpine-compatible release, run this command in your terminal: ```sh curl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi-alpine.tar.gz ``` To download a specific Alpine-compatible release, run this command in your terminal: ```sh curl -OL https://github.com/asyncapi/cli/releases/download//asyncapi-alpine.tar.gz ``` Once downloaded, untar the file: ```sh tar -xzf asyncapi-alpine.tar.gz ``` #### For other Linux distributions (glibc-based): To download the latest release of the CLI, run this command in your terminal: ```sh curl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi.tar.gz ``` To download a specific release of the CLI, run this command in your terminal: ```sh curl -OL https://github.com/asyncapi/cli/releases/download//asyncapi.tar.gz ``` Once you have downloaded the archived file, untar it by running this command in your terminal: ```sh tar -xzf asyncapi.tar.gz ``` ### Setting up the symlink (for both Alpine and glibc versions): The step above will create an `AsyncAPI` directory in the current path. To run the CLI from anywhere, you must create a `symlink`. If the current path you are on is `/user/local/bin`, for example, you must create the `symlink` in the `/user/local/bin` directory by following these steps: ```sh # cd into the unarchived directory cd asyncapi # get the absolute path pwd # Create a symlink ln -s /bin/asyncapi /user/local/bin/asyncapi # The "asyncapi" command should be available to be used asyncapi ``` > [!NOTE] > If youare using Alpine Linux or any musl-based distribution, make sure to download the `-alpine.tar.gz` version to avoid glibc compatibility issues. The regular `asyncapi.tar.gz` file is compiled for glibc-based systems and will not work on Alpine.