Skip to content

Commit

Permalink
docs(cli): update latest cli documentation (#2034)
Browse files Browse the repository at this point in the history
  • Loading branch information
asyncapi-bot authored Aug 7, 2023
1 parent 1e6e5e3 commit cae92c3
Showing 1 changed file with 61 additions and 14 deletions.
75 changes: 61 additions & 14 deletions pages/docs/tools/cli/usage.md
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.51.12 linux-x64 node-v18.17.0
@asyncapi/cli/0.51.13 linux-x64 node-v18.17.0
$ asyncapi --help [COMMAND]
USAGE
$ asyncapi COMMAND
Expand All @@ -45,6 +45,8 @@ USAGE
* [`asyncapi config context`](#asyncapi-config-context)
* [`asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`](#asyncapi-config-context-add-context-name-spec-file-path)
* [`asyncapi config context current`](#asyncapi-config-context-current)
* [`asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`](#asyncapi-config-context-edit-context-name-new-spec-file-path)
* [`asyncapi config context init [CONTEXT-FILE-PATH]`](#asyncapi-config-context-init-context-file-path)
* [`asyncapi config context list`](#asyncapi-config-context-list)
* [`asyncapi config context remove CONTEXT-NAME`](#asyncapi-config-context-remove-context-name)
* [`asyncapi config context use CONTEXT-NAME`](#asyncapi-config-context-use-context-name)
Expand Down Expand Up @@ -91,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.51.12/src/commands/bundle.ts)_
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v0.51.13/src/commands/bundle.ts)_

## `asyncapi config`

Expand All @@ -105,18 +107,23 @@ DESCRIPTION
CLI config settings
```

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

## `asyncapi config context`

Manage short aliases for full paths to AsyncAPI documents

```
USAGE
$ asyncapi config context
DESCRIPTION
Manage short aliases for full paths to AsyncAPI documents
```

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

Add or modify a context in the store
Add a context to the store

```
USAGE
Expand All @@ -130,7 +137,7 @@ FLAGS
-h, --help Show CLI help.
DESCRIPTION
Add or modify a context in the store
Add a context to the store
```

## `asyncapi config context current`
Expand All @@ -148,9 +155,49 @@ DESCRIPTION
Shows the current context that is being used
```

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

Edit a context in the store

```
USAGE
$ asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH [-h]
ARGUMENTS
CONTEXT-NAME context name
NEW-SPEC-FILE-PATH new file path of the spec file
FLAGS
-h, --help Show CLI help.
DESCRIPTION
Edit a context in the store
```

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

Initialize context

```
USAGE
$ asyncapi config context init [CONTEXT-FILE-PATH] [-h]
ARGUMENTS
CONTEXT-FILE-PATH Specify directory in which context file should be created:
- current directory : asyncapi config context init . (default)
- root of current repository : asyncapi config context init ./
- user's home directory : asyncapi config context init ~
FLAGS
-h, --help Show CLI help.
DESCRIPTION
Initialize context
```

## `asyncapi config context list`

List all the stored context in the store
List all the stored contexts in the store

```
USAGE
Expand All @@ -160,7 +207,7 @@ FLAGS
-h, --help Show CLI help.
DESCRIPTION
List all the stored context in the store
List all the stored contexts in the store
```

## `asyncapi config context remove CONTEXT-NAME`
Expand Down Expand Up @@ -234,7 +281,7 @@ DESCRIPTION
Convert asyncapi documents older to newer versions
```

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

## `asyncapi diff OLD NEW`

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

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

## `asyncapi generate`

Expand All @@ -303,7 +350,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.51.12/src/commands/generate/index.ts)_
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v0.51.13/src/commands/generate/index.ts)_

## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE`

Expand Down Expand Up @@ -432,7 +479,7 @@ DESCRIPTION
Creates a new asyncapi file
```

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

## `asyncapi new file`

Expand Down Expand Up @@ -520,7 +567,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.51.12/src/commands/optimize.ts)_
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v0.51.13/src/commands/optimize.ts)_

## `asyncapi start`

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

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

## `asyncapi start studio`

Expand Down Expand Up @@ -578,5 +625,5 @@ DESCRIPTION
validate asyncapi file
```

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

0 comments on commit cae92c3

Please sign in to comment.