Skip to content

Commit

Permalink
Merge branch 'master' into newstore
Browse files Browse the repository at this point in the history
  • Loading branch information
@derberg
derberg authored Nov 8, 2023
2 parents adeaac5 + 2e7ae53 commit fef199a
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 45 deletions.
12 changes: 6 additions & 6 deletions config/newsroom_videos.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@
"description": "Powered by Restream https://restream.io https://github.com/asyncapi/community/issues/916.",
"videoId": "Vm4ZKFb2PVE"
},
{
"image_url": "https://i.ytimg.com/vi/FN5eR1Zqh9c/hqdefault.jpg",
"title": "AsyncAPI Conf on Tour 2023 in Madrid",
"description": "AACoT'23 Madrid Edition streamed live from StageOne at SNGULAR. 00:00 Waiting 57:12 Opening 1:26:07 Everything You Wish ...",
"videoId": "FN5eR1Zqh9c"
},
{
"image_url": "https://i.ytimg.com/vi/zSbv4ibqYds/hqdefault.jpg",
"title": "Community Meeting(October 17th, 2023)",
Expand All @@ -28,5 +22,11 @@
"title": "Spec 3.0 docs meeting (September 28, 2023)",
"description": "https://github.com/asyncapi/community/issues/885.",
"videoId": "qjMojQ-fFew"
},
{
"image_url": "https://i.ytimg.com/vi/SfATYVwcSQk/hqdefault.jpg",
"title": "Community meeting (September 19, 2023)",
"description": "https://github.com/asyncapi/community/issues/874.",
"videoId": "SfATYVwcSQk"
}
]
31 changes: 18 additions & 13 deletions dashboard.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"resourcePath": "/asyncapi/website/pull/2038",
"repo": "asyncapi/website",
"labels": [],
"score": 39.34291865864845
"score": 39.63009324739771
},
{
"id": "PR_kwDOFLhIt85Vmgtj",
Expand All @@ -52,7 +52,23 @@
"resourcePath": "/asyncapi/community/pull/805",
"repo": "asyncapi/community",
"labels": [],
"score": 30.440506407421427
"score": 30.727680996170687
},
{
"id": "I_kwDOBGu-184_rP6l",
"isPR": false,
"isAssigned": false,
"title": "Let channels be identified by an ID rather than their address.",
"author": "smoya",
"resourcePath": "/asyncapi/spec/issues/663",
"repo": "asyncapi/spec",
"labels": [
{
"name": "💭 Strawman (RFC 0)",
"color": "C2E0C6"
}
],
"score": 21.538094156194408
},
{
"id": "I_kwDOBW5R_c5BIl5P",
Expand Down Expand Up @@ -170,17 +186,6 @@
}
],
"score": 14.07155484871368
},
{
"id": "PR_kwDOCoBobc42aMuI",
"isPR": true,
"isAssigned": false,
"title": "feat: release for version 3.0.0 of the spec",
"author": "jonaslagoni",
"resourcePath": "/asyncapi/parser-js/pull/526",
"repo": "asyncapi/parser-js",
"labels": [],
"score": 13.497205671215161
}
],
"goodFirstIssues": [
Expand Down
32 changes: 31 additions & 1 deletion pages/docs/tools/cli/installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,40 @@ sudo installer -pkg asyncapi.pkg -target /
```

## Windows
For Windows just install the appropriate installer and simply follow the default installation steps to complete the installation process.

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.

Expand Down
50 changes: 25 additions & 25 deletions pages/docs/tools/cli/usage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ $ npm install -g @asyncapi/cli
$ asyncapi COMMAND
running command...
$ asyncapi (--version)
@asyncapi/cli/0.59.0 linux-x64 node-v18.18.2
@asyncapi/cli/0.59.2 linux-x64 node-v18.18.2
$ asyncapi --help [COMMAND]
USAGE
$ asyncapi COMMAND
Expand Down Expand Up @@ -93,7 +93,7 @@ EXAMPLES
$ asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./asyncapi.yaml --reference-into-components
```

_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/bundle.ts)_
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/bundle.ts)_

## `asyncapi config`

Expand All @@ -107,7 +107,7 @@ DESCRIPTION
CLI config settings
```

_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/config/index.ts)_
_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/config/index.ts)_

## `asyncapi config context`

Expand All @@ -121,7 +121,7 @@ DESCRIPTION
Manage short aliases for full paths to AsyncAPI documents
```

_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/config/context/index.ts)_
_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/config/context/index.ts)_

## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`

Expand All @@ -143,7 +143,7 @@ DESCRIPTION
Add a context to the store
```

_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/config/context/add.ts)_
_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/config/context/add.ts)_

## `asyncapi config context current`

Expand All @@ -160,7 +160,7 @@ DESCRIPTION
Shows the current context that is being used
```

_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/config/context/current.ts)_
_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/config/context/current.ts)_

## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`

Expand All @@ -181,7 +181,7 @@ DESCRIPTION
Edit a context in the store
```

_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/config/context/edit.ts)_
_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/config/context/edit.ts)_

## `asyncapi config context init [CONTEXT-FILE-PATH]`

Expand All @@ -204,7 +204,7 @@ DESCRIPTION
Initialize context
```

_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/config/context/init.ts)_
_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/config/context/init.ts)_

## `asyncapi config context list`

Expand All @@ -221,7 +221,7 @@ DESCRIPTION
List all the stored contexts in the store
```

_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/config/context/list.ts)_
_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/config/context/list.ts)_

## `asyncapi config context remove CONTEXT-NAME`

Expand All @@ -241,7 +241,7 @@ DESCRIPTION
Delete a context from the store
```

_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/config/context/remove.ts)_
_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/config/context/remove.ts)_

## `asyncapi config context use CONTEXT-NAME`

Expand All @@ -261,7 +261,7 @@ DESCRIPTION
Set a context as current
```

_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/config/context/use.ts)_
_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/config/context/use.ts)_

## `asyncapi config versions`

Expand All @@ -278,7 +278,7 @@ DESCRIPTION
Show versions of AsyncAPI tools used
```

_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/config/versions.ts)_
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/config/versions.ts)_

## `asyncapi convert [SPEC-FILE]`

Expand All @@ -300,7 +300,7 @@ DESCRIPTION
Convert asyncapi documents older to newer versions
```

_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/convert.ts)_
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/convert.ts)_

## `asyncapi diff OLD NEW`

Expand Down Expand Up @@ -355,7 +355,7 @@ DESCRIPTION
Find diff between two asyncapi files
```

_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/diff.ts)_
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/diff.ts)_

## `asyncapi generate`

Expand All @@ -369,7 +369,7 @@ DESCRIPTION
Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.
```

_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/generate/index.ts)_
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/generate/index.ts)_

## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE`

Expand Down Expand Up @@ -406,7 +406,7 @@ EXAMPLES
$ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write
```

_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/generate/fromTemplate.ts)_
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/generate/fromTemplate.ts)_

## `asyncapi generate models LANGUAGE FILE`

Expand Down Expand Up @@ -480,7 +480,7 @@ DESCRIPTION
Generates typed models
```

_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/generate/models.ts)_
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/generate/models.ts)_

## `asyncapi new`

Expand Down Expand Up @@ -535,7 +535,7 @@ EXAMPLES
$ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode
```

_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/new/index.ts)_
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/new/index.ts)_

## `asyncapi new file`

Expand Down Expand Up @@ -590,7 +590,7 @@ EXAMPLES
$ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode
```

_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/new/file.ts)_
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/new/file.ts)_

## `asyncapi new glee`

Expand All @@ -608,7 +608,7 @@ DESCRIPTION
Creates a new Glee project
```

_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/new/glee.ts)_
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/new/glee.ts)_

## `asyncapi new project`

Expand All @@ -626,7 +626,7 @@ DESCRIPTION
Creates a new Glee project
```

_See code: [src/commands/new/project.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/new/project.ts)_
_See code: [src/commands/new/project.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/new/project.ts)_

## `asyncapi optimize [SPEC-FILE]`

Expand Down Expand Up @@ -662,7 +662,7 @@ EXAMPLES
$ asyncapi optimize ./asyncapi.yaml --optimization=remove-components,reuse-components,move-to-components --output=terminal --no-tty
```

_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/optimize.ts)_
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/optimize.ts)_

## `asyncapi start`

Expand All @@ -676,7 +676,7 @@ DESCRIPTION
Start asyncapi studio
```

_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/start/index.ts)_
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/start/index.ts)_

## `asyncapi start studio`

Expand All @@ -695,7 +695,7 @@ DESCRIPTION
starts a new local instance of Studio
```

_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/start/studio.ts)_
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/start/studio.ts)_

## `asyncapi validate [SPEC-FILE]`

Expand All @@ -722,5 +722,5 @@ DESCRIPTION
validate asyncapi file
```

_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v0.59.0/src/commands/validate.ts)_
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v0.59.2/src/commands/validate.ts)_
<!-- commandsstop -->

0 comments on commit fef199a

Please sign in to comment.