Skip to content

Commit 76b668a

Browse files
jamessouthyyx990803
authored andcommitted
docs: add note about Git Bash on Windows (#1885)
1 parent d589460 commit 76b668a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/guide/creating-a-project.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ To create a new project, run:
88
vue create hello-world
99
```
1010

11+
::: warning
12+
If you are on Windows using Git Bash with minTTY, the interactive prompts will not work. You must launch the command as `winpty vue.cmd create hello-world`.
13+
:::
14+
1115
You will be prompted to pick a preset. You can either choose the default preset which comes with a basic Babel + ESLint setup, or select "Manually select features" to pick the features you need.
1216

1317
![CLI preview](/cli-new-project.png)
@@ -43,7 +47,7 @@ Options:
4347
-i, --inlinePreset <json> Skip prompts and use inline JSON string as preset
4448
-m, --packageManager <command> Use specified npm client when installing dependencies
4549
-r, --registry <url> Use specified npm registry when installing dependencies (only for npm)
46-
-g, --git [message|false] Force / skip git intialization, optionally specify initial commit message
50+
-g, --git [message|false] Force / skip git initialization, optionally specify initial commit message
4751
-f, --force Overwrite target directory if it exists
4852
-c, --clone Use git clone when fetching remote preset
4953
-x, --proxy Use specified proxy when creating project

0 commit comments

Comments
 (0)