Skip to content

docs: correct npx package resolution guidance #25673

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

Open
MinhPhuong-hub wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: correct npx package resolution guidance #25673

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 docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Then, **generate** a ruby client from a valid [petstore.yaml](https://raw.github
npx @openapitools/openapi-generator-cli generate -i petstore.yaml -g ruby -o /tmp/test/
```

> `npx` will execute a globally available `openapi-generator`, and if not found it will fall back to project-local commands. The result is that the above command will work regardless of which installation method you've chosen.
> When `@openapitools/openapi-generator-cli` is installed in the current project, `npx` uses the local package. Otherwise, npm may fetch the package into its cache and prompt for confirmation. To run a globally installed CLI, invoke `openapi-generator-cli` directly.

## Homebrew

Expand Down