Skip to content

Commit

Permalink
Merge branch 'master' into create-new-glee-project
Browse files Browse the repository at this point in the history
  • Loading branch information
peter-rr authored Apr 20, 2023
2 parents 5c94471 + 644e0eb commit da3b33b
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/update-docs-in-website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
working-directory: ./website
run: |
mkdir -p ./pages/docs/tools/cli
printf "%s\ntitle: CLI\nweight: 30\n%s" "---" "---"> ../cli/docs/_section.md
printf "%s\ntitle: CLI\nweight: 10\n%s" "---" "---"> ../cli/docs/_section.md
mv ../cli/docs/*.md ./pages/docs/tools/cli
- name: Commit and push
working-directory: ./website
Expand Down
3 changes: 1 addition & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'Introduction'
weight: 10
weight: 20
---

# Introduction
The AsyncAPI CLI is a tool you can use to work with your AsyncAPI documents. You can use the CLI to validate AsyncAPI documents, use the Generator tool, and even create new AsyncAPI documents.
22 changes: 13 additions & 9 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: 'Installation'
weight: 20
title: 'Installation guide'
weight: 30
---

## Installation Guide
## Node and npm

To use the AsynAPI CLI tool, you must install NPM and a Node.js version 10 or higher. To check if you already have both installed, run the following commands in your terminal:

```sh
Expand All @@ -25,10 +26,11 @@ After installing Node.js and NPM, run the following command to install the Async
npm install -g @asyncapi/cli
```

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

#### `brew` installation
### brew

To install the AsyncAPI CLI using the `brew` package manager, run the following commands in your terminal:
```sh
# Install brew
Expand All @@ -38,7 +40,8 @@ To install the AsyncAPI CLI using the `brew` package manager, run the following
brew install asyncapi
```

#### `pkg` installation
### 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
Expand All @@ -64,10 +67,11 @@ After downloading the AsyncAPI CLI, install it via the following command:
sudo installer -pkg asyncapi.pkg -target /
```

### Linux
## Linux
Selecting the appropriate AsyncAPI CLI installation method on a Linux operating system depends on your Linux distro.

#### Debian based distros
### 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
Expand All @@ -78,7 +82,7 @@ To download a specific release of the CLI, run this command in your terminal:
curl -OL https://github.com/asyncapi/cli/releases/download/<replace this with the specific CLI version e.g v0.13.0>/asyncapi.deb
```

#### Other distros
### Other distros
You can install the AsyncAPI CLI for other Linux distros using the archive `tar.gz` file. 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
Expand Down
3 changes: 1 addition & 2 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: 'Usage'
weight: 30
weight: 40
---

## Usage
The AsyncAPI CLI makes it easier to work with AsyncAPI documents.

To get **help**, run this command in your terminal:
Expand Down
2 changes: 2 additions & 0 deletions test/commands/diff.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
import { test } from '@oclif/test';

describe('diff', () => {
jest.setTimeout(100000);

This comment has been minimized.

Copy link
@peter-rr

peter-rr Apr 20, 2023

Author Member

@derberg After this change, should I update the timeout in jest.config.ts to the previous value then? 🤔
https://github.com/asyncapi/cli/pull/418/files#diff-860bd1f15d1e0bafcfc6f62560524f588e6d6bf56d4ab1b0f6f8146461558730


describe('with file paths, and there are no difference between the files', () => {
test
.stderr()
Expand Down

0 comments on commit da3b33b

Please sign in to comment.