Skip to content

Commit

Permalink
docs(cli): update latest cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
asyncapi-bot committed Jun 28, 2023
1 parent 1231f00 commit f4eec05
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 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.48.8 linux-x64 node-v18.16.0
@asyncapi/cli/0.49.0 linux-x64 node-v18.16.0
$ asyncapi --help [COMMAND]
USAGE
$ asyncapi COMMAND
Expand Down Expand Up @@ -91,7 +91,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.48.8/src/commands/bundle.ts)_
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v0.49.0/src/commands/bundle.ts)_

## `asyncapi config`

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

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

## `asyncapi config context`

Expand Down Expand Up @@ -234,7 +234,7 @@ DESCRIPTION
Convert asyncapi documents older to newer versions
```

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

## `asyncapi diff OLD NEW`

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

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

## `asyncapi generate`

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

## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE`

Expand Down Expand Up @@ -348,9 +348,9 @@ Generates typed models
USAGE
$ asyncapi generate models LANGUAGE FILE [-h] [-o <value>] [--tsModelType class|interface] [--tsEnumType
enum|union] [--tsModuleSystem ESM|CJS] [--tsIncludeComments] [--tsExportType default|named] [--tsJsonBinPack]
[--packageName <value>] [--namespace <value>] [--csharpAutoImplement] [--csharpNewtonsoft] [--csharpArrayType
Array|List] [--csharpHashcode] [--csharpEqual] [--csharpSystemJson] [--log-diagnostics] [--diagnostics-format
json|stylish|junit|html|text|teamcity|pretty] [--fail-severity error|warn|info|hint]
[--tsMarshalling] [--packageName <value>] [--namespace <value>] [--csharpAutoImplement] [--csharpNewtonsoft]
[--csharpArrayType Array|List] [--csharpHashcode] [--csharpEqual] [--csharpSystemJson] [--log-diagnostics]
[--diagnostics-format json|stylish|junit|html|text|teamcity|pretty] [--fail-severity error|warn|info|hint]
ARGUMENTS
LANGUAGE (typescript|csharp|golang|java|javascript|dart|python|rust|kotlin|php|cplusplus) The language you want the
Expand Down Expand Up @@ -396,6 +396,8 @@ FLAGS
while generating models.
--tsJsonBinPack TypeScript specific, define basic support for
serializing to and from binary with jsonbinpack.
--tsMarshalling TypeScript specific, generate the models with
marshalling functions.
--tsModelType=<option> [default: class] TypeScript specific, define
which type of model needs to be generated.
<options: class|interface>
Expand Down Expand Up @@ -427,7 +429,7 @@ DESCRIPTION
Creates a new asyncapi file
```

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

## `asyncapi new file`

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

## `asyncapi start`

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

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

## `asyncapi start studio`

Expand Down Expand Up @@ -573,5 +575,5 @@ DESCRIPTION
validate asyncapi file
```

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

0 comments on commit f4eec05

Please sign in to comment.