docs(respect): fix incorrect CLI commands and filenames in guides #261
Open
kakakakakku wants to merge 2 commits intoRedocly:mainfrom
Open
docs(respect): fix incorrect CLI commands and filenames in guides #261kakakakakku wants to merge 2 commits intoRedocly:mainfrom
kakakakakku wants to merge 2 commits intoRedocly:mainfrom
Conversation
kakakakakku
commented
Mar 10, 2026
| ```shell | ||
| npx @redocly/cli preview demo.yaml | ||
| npx @redocly/cli preview | ||
| ``` |
Author
There was a problem hiding this comment.
$ npx @redocly/cli preview demo.yaml
redocly preview
Preview Redocly project using one of the product NPM packages.
Options:
--version Show version number. [boolean]
--help Show help. [boolean]
--product Product used to launch preview. Default is in
ferred from project's package.json or 'realm'
is used.
[string] [choices: "redoc", "revel", "reef", "realm", "redoc-revel", "redoc-re
ef", "revel-reef"]
--plan [string] [choices: "pro", "enterprise"] [default: "enterprise"]
-p, --port Preview port. [number] [default: 4000]
-d, --project-dir, --source-dir Specifies the project content directory. The
default value is the directory where the comm
and is executed. [string] [default: "."]
--lint-config Severity level for config file linting.
[choices: "warn", "error", "off"] [default: "warn"]
Unknown argument: demo.yaml| ``` | ||
|
|
||
| You'll find the output in a file named `auto-generated.yaml`. Take a moment to examine the test description and you will notice that each operation from the OpenAPI file now has a workflow entry like the following example: | ||
| You'll find the output in a file named `auto-generated.arazzo.yaml`. Take a moment to examine the test description and you will notice that each operation from the OpenAPI file now has a workflow entry like the following example: |
Author
There was a problem hiding this comment.
$ npx @redocly/cli generate-arazzo demo.yaml
Generating Arazzo description...
Arazzo description auto-generated.arazzo.yaml successfully generated.$ npx @redocly/cli respect auto-generated.yaml --verbose
ENOENT: no such file or directory '/Users/xxx/xxx/auto-generated.yaml'
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What/Why/How?
Fix incorrect CLI commands and filenames in Respect guide documentation.
Reference
Testing
$ npx @redocly/cli respect auto-generated.arazzo.yaml --verbose (snip) Summary for auto-generated.arazzo.yaml Workflows: 14 passed, 14 total Steps: 14 passed, 14 total Checks: 53 passed, 53 total Time: 9251ms ┌────────────────────────────────────────────────────────────────────┬────────────┬─────────┬─────────┬──────────┐ │ Filename │ Workflows │ Passed │ Failed │ Warnings │ ├────────────────────────────────────────────────────────────────────┼────────────┼─────────┼─────────┼──────────┤ │ ✓ auto-generated.arazzo.yaml │ 14 │ 14 │ - │ - │ └────────────────────────────────────────────────────────────────────┴────────────┴─────────┴─────────┴──────────┘Screenshots (optional)
N/A
Check yourself
Security