Skip to content
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.

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

Improve CLI usage documentation on windows #1336

Open
breautek opened this issue Oct 5, 2023 · 1 comment
Open

Improve CLI usage documentation on windows #1336

breautek opened this issue Oct 5, 2023 · 1 comment

Comments

@breautek
Copy link
Contributor

breautek commented Oct 5, 2023

On windows using Command Prompt or Powershell, when we need to use the intermediate -- to pass through arguments, the -- needs to be enclosed in quotations

For example:

cordova build android --release "--" --packageType=apk

All of our examples show MacOS / Linux usage. This is something I personally help people resolve in discussions/slack, but can also be a source of bug reports.

Below is a list of links that I found that uses pass through CLI args, but this list may not be exhaustive.

https://cordova.apache.org/docs/en/12.x/reference/cordova-cli/index.html
https://cordova.apache.org/docs/en/12.x/guide/platforms/android/index.html

@breautek
Copy link
Contributor Author

breautek commented Oct 5, 2023

Alternatively instead of having a "windows" and "unix/bash" version of the command line, cordova build android --release "--" --packageType=apk does appear to work in bash environments as well. So avoid creating too much verbosity we could just show all CLI examples to use the "--" separator, with the quotations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant