Skip to content
Merged
Show file tree
Hide file tree
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
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,43 @@ Command line interface for building NW.js apps
Create a Vanilla JavaScript project.

```shell
nw create MyApp
└─$ nw-cli create --help
Usage: nw-cli create [options] <name>

Arguments:
name app name

Options:
--template <template> template name (default: "vanilla-js")
--outDir <dir> output directory (default: ".")
-h, --help display help for command
```

Choose your template (defaults to `vanilla-js`) and out directory (defaults to `.`).
### dev

Run application in development mode.

```shell
nw create --template=react-js --outDir=/path/to/project/dir MyApp
└─$ nw-cli dev --help
Usage: nw-cli dev [options]

Run app in development mode

Options:
--version <version> NW.js version (default: "latest")
--flavor <flavor> NW.js flavor (default: "normal")
--platform <platform> NW.js platform (default: "linux")
--arch <arch> NW.js architecture (default: "x64")
--downloadUrl <string> Download URL (default: "https://dl.nwjs.io")
--manifestUrl <string> Manifest URL (default: "https://nwjs.io/versions.json")
--cacheDir <dir> Cache directory (default: "/home/localghost/.nw-cli/cache")
--cache <boolean> Cache binaries (default: true)
--ffmpeg <boolean> Download community ffmpeg (default: false)
--nativeAddon <boolean> Download NW.js Node headers (default: false)
--shaSum <boolean> Verify SHASUM (default: true)
--srcDir <dir> Project source directory (default: ".")
--argv <item...> Command line arguments (default: [])
-h, --help display help for command
```

> Note: If you find a template is missing, feel free to open an issue or pull request.
Expand Down
Loading
Loading