Skip to content

docs(cli): update latest cli documentation #3678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
asyncapi-bot merged 1 commit into from
Feb 14, 2025
Merged

docs(cli): update latest cli documentation #3678

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 3 additions & 46 deletions markdown/docs/tools/cli/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,58 +537,15 @@ _See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blo

## `asyncapi new`

Creates a new asyncapi file
Create a new AsyncAPI project, specification files, or templates for clients and applications.

```
USAGE
$ asyncapi new [-h] [-n <value>] [-e <value>] [-s] [-p <value>] [--no-tty]

FLAGS
-e, --example=<value>
name of the example to use. Available examples are:
- simple-asyncapi.yml
- adeo-kafka-request-reply-asyncapi.yml
- anyof-asyncapi.yml
- application-headers-asyncapi.yml
- correlation-id-asyncapi.yml
- websocket-gemini-asyncapi.yml
- gitter-streaming-asyncapi.yml
- kraken-websocket-request-reply-message-filter-in-reply-asyncapi.yml
- kraken-websocket-request-reply-multiple-channels-asyncapi.yml
- mercure-asyncapi.yml
- not-asyncapi.yml
- operation-security-asyncapi.yml
- oneof-asyncapi.yml
- rpc-client-asyncapi.yml
- rpc-server-asyncapi.yml
- slack-rtm-asyncapi.yml
- tutorial.yml
- streetlights-kafka-asyncapi.yml
- streetlights-operation-security-asyncapi.yml
- streetlights-mqtt-asyncapi.yml

-h, --help
Show CLI help.

-n, --file-name=<value>
name of the file

-p, --port=<value>
port in which to start Studio

-s, --studio
open in Studio

--no-tty
do not use an interactive terminal
$ asyncapi new
Comment on lines 542 to +544
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add language specifier to the code block.

The code block is missing a language specifier, which is required by markdown linting rules.

Apply this diff to fix the issue:

-```
+```sh
 $ asyncapi new
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

542-542: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)


DESCRIPTION
Creates a new asyncapi file

EXAMPLES
$ asyncapi new - start creation of a file in interactive mode
Create a new AsyncAPI project, specification files, or templates for clients and applications.

$ asyncapi new --file-name=my-asyncapi.yaml --example=default-example.yaml --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.14.1/src/commands/new/index.ts)_
Expand Down
Loading