Skip to content

Commit

Permalink
Merge branch 'master' into toolsFileFix
Browse files Browse the repository at this point in the history
  • Loading branch information
akshatnema authored Nov 22, 2024
2 parents 8bce4e0 + 4c5f284 commit b0c7afc
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 46 deletions.
14 changes: 0 additions & 14 deletions config/meetings.json
Original file line number Diff line number Diff line change
@@ -1,25 +1,11 @@
[
{
"title": "Essential Building Blocks Working Group",
"calLink": "https://www.google.com/calendar/event?eid=YzYyaHNiNTdqbGQ1OTNybjE1NDZlb2ppODAgY19xOXRzZWlnbG9tZHNqNm5qdWh2YnB0czExY0Bn",
"url": "https://github.com/asyncapi/community/issues/1331",
"banner": "",
"date": "2024-08-13T18:00:00.000Z"
},
{
"title": "Community Meeting",
"calLink": "https://www.google.com/calendar/event?eid=cnIwc3U0c2o1a3FoaWM0M2VvZXFjNzJvZzQgY19xOXRzZWlnbG9tZHNqNm5qdWh2YnB0czExY0Bn",
"url": "https://github.com/asyncapi/community/issues/1336",
"banner": "https://github.com/user-attachments/assets/7756ebe2-f8c7-4bda-91e3-6a678c1fad99",
"date": "2024-08-20T16:00:00.000Z"
},
{
"title": "Marketing WG Meeting",
"calLink": "https://www.google.com/calendar/event?eid=dDNtNmxyODRkNzdvOTdvaWV0NjhtZnYyMGcgY19xOXRzZWlnbG9tZHNqNm5qdWh2YnB0czExY0Bn",
"url": "https://github.com/asyncapi/community/issues/1338",
"banner": "",
"date": "2024-08-13T14:00:00.000Z"
},
{
"title": "Essential Building Blocks Working Group",
"calLink": "https://www.google.com/calendar/event?eid=c28zazMxcDk3MThpMWFpNG9lYzRrbmIzNW8gY19xOXRzZWlnbG9tZHNqNm5qdWh2YnB0czExY0Bn",
Expand Down
12 changes: 6 additions & 6 deletions config/newsroom_videos.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
[
{
"image_url": "https://i.ytimg.com/vi/Q2cvxsUUgzA/hqdefault.jpg",
"title": "AsyncAPI-Powered Event Feeds: 3 Steps to Streaming",
"description": "In this livestream, we'll dive into the challenges and benefits of using AsyncAPI for building event-driven architectures.",
"videoId": "Q2cvxsUUgzA"
},
{
"image_url": "https://i.ytimg.com/vi/9MaHh4b-rmc/hqdefault.jpg",
"title": "Broadening the API Landscape: AsyncAPI and CloudEvents in the Enterprise - Daniel Kocot",
Expand All @@ -22,11 +28,5 @@
"title": "Sustaining Open Source Beyond Code: The Importance of Marketing and Funding - Oluwabamikemi Kayode",
"description": "",
"videoId": "b_BStEcLNqg"
},
{
"image_url": "https://i.ytimg.com/vi/G6YyV1JvvSM/hqdefault.jpg",
"title": "Streamlining EDA: AsyncAPI-Driven Design, Documentation, and Testing - Giri Venkatesan",
"description": "",
"videoId": "G6YyV1JvvSM"
}
]
102 changes: 76 additions & 26 deletions markdown/docs/tools/cli/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ $ npm install -g @asyncapi/cli
$ asyncapi COMMAND
running command...
$ asyncapi (--version)
@asyncapi/cli/2.8.1 linux-x64 node-v18.20.4
@asyncapi/cli/2.10.0 linux-x64 node-v18.20.5
$ asyncapi --help [COMMAND]
USAGE
$ asyncapi COMMAND
Expand All @@ -52,6 +52,7 @@ USAGE
* [`asyncapi config versions`](#asyncapi-config-versions)
* [`asyncapi convert [SPEC-FILE]`](#asyncapi-convert-spec-file)
* [`asyncapi diff OLD NEW`](#asyncapi-diff-old-new)
* [`asyncapi format [SPEC-FILE]`](#asyncapi-format-spec-file)
* [`asyncapi generate`](#asyncapi-generate)
* [`asyncapi generate fromTemplate ASYNCAPI TEMPLATE`](#asyncapi-generate-fromtemplate-asyncapi-template)
* [`asyncapi generate models LANGUAGE FILE`](#asyncapi-generate-models-language-file)
Expand All @@ -60,6 +61,7 @@ USAGE
* [`asyncapi new glee`](#asyncapi-new-glee)
* [`asyncapi new template`](#asyncapi-new-template)
* [`asyncapi optimize [SPEC-FILE]`](#asyncapi-optimize-spec-file)
* [`asyncapi pretty SPEC-FILE`](#asyncapi-pretty-spec-file)
* [`asyncapi start`](#asyncapi-start)
* [`asyncapi start studio`](#asyncapi-start-studio)
* [`asyncapi validate [SPEC-FILE]`](#asyncapi-validate-spec-file)
Expand Down Expand Up @@ -99,7 +101,7 @@ EXAMPLES
$ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service
```

_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/bundle.ts)_
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/bundle.ts)_

## `asyncapi config`

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

_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/config/index.ts)_
_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/config/index.ts)_

## `asyncapi config analytics`

Expand All @@ -133,7 +135,7 @@ DESCRIPTION
Enable or disable analytics for metrics collection
```

_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/config/analytics.ts)_
_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/config/analytics.ts)_

## `asyncapi config context`

Expand All @@ -147,7 +149,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/v2.8.1/src/commands/config/context/index.ts)_
_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/config/context/index.ts)_

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

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

_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/config/context/add.ts)_
_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/config/context/add.ts)_

## `asyncapi config context current`

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

_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/config/context/current.ts)_
_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/config/context/current.ts)_

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

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

_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/config/context/edit.ts)_
_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/config/context/edit.ts)_

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

Expand All @@ -230,7 +232,7 @@ DESCRIPTION
Initialize context
```

_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/config/context/init.ts)_
_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/config/context/init.ts)_

## `asyncapi config context list`

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

_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/config/context/list.ts)_
_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/config/context/list.ts)_

## `asyncapi config context remove CONTEXT-NAME`

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

_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/config/context/remove.ts)_
_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/config/context/remove.ts)_

## `asyncapi config context use CONTEXT-NAME`

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

_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/config/context/use.ts)_
_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/config/context/use.ts)_

## `asyncapi config versions`

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

_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/config/versions.ts)_
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/config/versions.ts)_

## `asyncapi convert [SPEC-FILE]`

Expand Down Expand Up @@ -332,7 +334,7 @@ DESCRIPTION
Convert asyncapi documents older to newer versions or OpenAPI/postman-collection documents to AsyncAPI
```

_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/convert.ts)_
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/convert.ts)_

## `asyncapi diff OLD NEW`

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

_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/diff.ts)_
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/diff.ts)_

## `asyncapi format [SPEC-FILE]`

Convert asyncapi documents from any format to yaml, yml or JSON

```
USAGE
$ asyncapi format [SPEC-FILE] -f yaml|yml|json [-h] [-o <value>]
ARGUMENTS
SPEC-FILE spec path, url, or context-name
FLAGS
-f, --format=<option> (required) [default: json] Specify the format to convert to
<options: yaml|yml|json>
-h, --help Show CLI help.
-o, --output=<value> path to the file where the result is saved
DESCRIPTION
Convert asyncapi documents from any format to yaml, yml or JSON
```

_See code: [src/commands/format.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/format.ts)_

## `asyncapi generate`

Expand All @@ -387,7 +412,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/v2.8.1/src/commands/generate/index.ts)_
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/generate/index.ts)_

## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE`

Expand Down Expand Up @@ -432,7 +457,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/v2.8.1/src/commands/generate/fromTemplate.ts)_
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/generate/fromTemplate.ts)_

## `asyncapi generate models LANGUAGE FILE`

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

_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/generate/models.ts)_
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/generate/models.ts)_

## `asyncapi new`

Expand Down Expand Up @@ -560,7 +585,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/v2.8.1/src/commands/new/index.ts)_
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/new/index.ts)_

## `asyncapi new file`

Expand Down Expand Up @@ -618,7 +643,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/v2.8.1/src/commands/new/file.ts)_
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/new/file.ts)_

## `asyncapi new glee`

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

_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/new/glee.ts)_
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/new/glee.ts)_

## `asyncapi new template`

Expand All @@ -664,7 +689,7 @@ DESCRIPTION
Creates a new template
```

_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/new/template.ts)_
_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/new/template.ts)_

## `asyncapi optimize [SPEC-FILE]`

Expand Down Expand Up @@ -706,7 +731,32 @@ EXAMPLES
$ asyncapi optimize ./asyncapi.yaml --ignore=schema
```

_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/optimize.ts)_
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/optimize.ts)_

## `asyncapi pretty SPEC-FILE`

Format AsyncAPI specification file

```
USAGE
$ asyncapi pretty SPEC-FILE [-o <value>]
ARGUMENTS
SPEC-FILE spec path, url, or context-name
FLAGS
-o, --output=<value> Output file path
DESCRIPTION
Format AsyncAPI specification file
EXAMPLES
$ asyncapi pretty ./asyncapi.yaml
$ asyncapi pretty ./asyncapi.yaml --output formatted-asyncapi.yaml
```

_See code: [src/commands/pretty.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/pretty.ts)_

## `asyncapi start`

Expand All @@ -720,7 +770,7 @@ DESCRIPTION
Starts AsyncAPI-related services. Currently, it supports launching the AsyncAPI Studio
```

_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/start/index.ts)_
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/start/index.ts)_

## `asyncapi start studio`

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

_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.8.1/src/commands/start/studio.ts)_
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.10.0/src/commands/start/studio.ts)_

## `asyncapi validate [SPEC-FILE]`

Expand Down Expand Up @@ -770,5 +820,5 @@ DESCRIPTION
validate asyncapi file
```

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

0 comments on commit b0c7afc

Please sign in to comment.