Skip to content

Commit

Permalink
#369 Add CLI options and commands list to readme file. (#478)
Browse files Browse the repository at this point in the history
  • Loading branch information
easingthemes authored and styfle committed Oct 3, 2019
1 parent c0349a7 commit bfefbbc
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,39 @@ npm i -g @zeit/ncc

### Usage

```bash
$ ncc <cmd> <opts>
```
Eg:
```bash
$ ncc build input.js -o dist
```

Outputs the Node.js compact build of `input.js` into `dist/index.js`.


#### Commands:
```
build <input-file> [opts]
run <input-file> [opts]
cache clean|dir|size
help
version
```

#### Options:
```
-o, --out [file] Output directory for build (defaults to dist)
-m, --minify Minify output
-C, --no-cache Skip build cache population
-s, --source-map Generate source map
--no-source-map-register Skip source-map-register source map support
-e, --external [mod] Skip bundling 'mod'. Can be used many times
-q, --quiet Disable build summaries / non-error outputs
-w, --watch Start a watched build
--v8-cache Emit a build using the v8 compile cache
```

### Execution Testing

For testing and debugging, a file can be built into a temporary directory and executed with full source maps support with the command:
Expand Down

0 comments on commit bfefbbc

Please sign in to comment.