diff --git a/docs/guide/creating-a-project.md b/docs/guide/creating-a-project.md index b4e5953828..b8767a82da 100644 --- a/docs/guide/creating-a-project.md +++ b/docs/guide/creating-a-project.md @@ -8,6 +8,10 @@ To create a new project, run: vue create hello-world ``` +::: warning +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`. +::: + 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. ![CLI preview](/cli-new-project.png) @@ -43,7 +47,7 @@ Options: -i, --inlinePreset Skip prompts and use inline JSON string as preset -m, --packageManager Use specified npm client when installing dependencies -r, --registry Use specified npm registry when installing dependencies (only for npm) - -g, --git [message|false] Force / skip git intialization, optionally specify initial commit message + -g, --git [message|false] Force / skip git initialization, optionally specify initial commit message -f, --force Overwrite target directory if it exists -c, --clone Use git clone when fetching remote preset -x, --proxy Use specified proxy when creating project