Skip to content

Add option to run vue-cli through npx #564

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

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
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
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ $ npm install -g vue-cli
$ vue init <template-name> <project-name>
```

Or you may use npx and avoid global install if you are on npm >= 5

```bash
npx vue-cli init <template-name> <project-name>
```

Example:

``` bash
Expand Down Expand Up @@ -79,7 +85,7 @@ vue init ~/fs/path/to-custom-template my-project
- `prompts`: used to collect user options data;

- `filters`: used to conditional filter files to render.

- `metalsmith`: used to add custom metalsmith plugins in the chain.

- `completeMessage`: the message to be displayed to the user when the template has been generated. You can include custom instruction here.
Expand Down Expand Up @@ -196,7 +202,7 @@ You may customize the metalsmith builder created by vue-cli to register custom p
// Implement something really custom here.
done(null, files)
}

metalsmith.use(customMetalsmithPlugin)
}
}
Expand Down