Skip to content

docs: update docker installation section to mention docker Hub image #2238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pvbang wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update docker installation section to mention docker Hub image #2238

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 40 additions & 7 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,28 +47,61 @@ To refresh the variables:

## 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 :
Install [Docker](https://docs.docker.com/get-docker/) first. There are two ways to use the AsyncAPI CLI with Docker: pulling the official image from Docker Hub (recommended) or building the image from source.

### Using the official Docker Hub image (recommended)

The AsyncAPI CLI is available as an official image on [Docker Hub](https://hub.docker.com/r/asyncapi/cli). You can pull and use it directly without building from source.

To pull the latest version:
```sh
docker pull asyncapi/cli
```

To pull a specific version:
```sh
docker pull asyncapi/cli:2.12.0
```

You can find all available tags on the [Docker Hub tags page](https://hub.docker.com/r/asyncapi/cli/tags).

To run the CLI using the Docker Hub image:
```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]
```

For example, to validate an AsyncAPI specification file:
```bash
docker run --rm -it \
--user=root \
-v ${PWD}/asyncapi.yml:/app/asyncapi.yml \
asyncapi/cli validate /app/asyncapi.yml
```

# 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.
To generate output from a template:
```bash
docker run --rm -it \
--user=root \
-v ${PWD}/test/integration/fixtures/asyncapi_v1.yml:/app/asyncapi.yml \
-v ${PWD}/asyncapi.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.

### Building from source

If you prefer to build the Docker image from the source code, clone the repository and run:
```sh
docker build -t asyncapi/cli:latest .
```

Then run it using the same commands shown above.


## Mac
There are two ways to install the AsyncAPI CLI on your macOS: using the `brew` package manager or `pkg` files.
Expand Down
Loading