Improve CLI usage documentation on windows
- Dominant language
- JavaScript
- Stars
- 353
- Forks
- 565
- Avg merge
- 7h 15m
- Merged PRs (30d)
- 5
Description
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](https://github.com/apache/cordova-android/issues/1671).
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
Contributor guide
Research direction
Review the linked Cordova CLI and Android platform documentation pages, starting with the examples that pass through CLI arguments using `--`. Add the Windows Command Prompt and PowerShell quoting guidance to the relevant examples, then verify that all listed pass-through examples show correct Windows usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100