Skip to content

docs(cli): update latest cli documentation #3576

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
Jan 15, 2025
Merged

docs(cli): update latest cli documentation #3576

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
2 changes: 1 addition & 1 deletion markdown/docs/tools/cli/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,7 +586,7 @@ DESCRIPTION
EXAMPLES
$ asyncapi new - start creation of a file in interactive mode

$ 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
$ 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
Copy link
Contributor

@coderabbitai coderabbitai bot Jan 15, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue

LGTM! File extension update looks good.

The change from .yml to .yaml in the example command ensures consistency in file extension usage across documentation.

Fix formatting: Replace hard tab with spaces.

There's a hard tab in the line that should be replaced with spaces for consistent formatting.

Apply this diff to fix the formatting:

-	 - create a new file with a specific name, using one of the examples and without interactive mode
+  - create a new file with a specific name, using one of the examples and without interactive mode
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
$ 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
$ 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
🧰 Tools
🪛 Markdownlint (0.37.0)

589-589: Column: 86
Hard tabs

(MD010, no-hard-tabs)

```

_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/new/index.ts)_
Expand Down
Loading