0.3.3 • Published 2 years ago
@dingos/web-fs v0.3.3
PWA-KIT_CLI usage instructions：
Default you have installed node.
Installation
npm install pwa-kit-cli -g
Command Line Interface
kit <command> [options]
create manifest.json file or serviceWorker.js file
kit gen [optsions]
options
| Option | Description |
|---|---|
-t, --type | The file type，manifest or serviceWorker，Optional value <all | manifest | sw>，The 'all' is generated for both representatives. |
-o, --out | Path of the file output |
-n, --name | the name field for manifest.json. |
-sn, --shortName | 'the shortName field for manifest.json'. |
-d, --display | the display field for manifest.json, default value standalone |
-s, --startUrl | the startUrl field for manifest.json. |
-i, --icons | the icons field for manifest.json. |
-bc, --backgroundColor | the backgroundColor field for manifest.json. |
-tc, --themeColor | the themeColor field for manifest.json. |
--description | the description field for manifest.json. |
--scope | the scope field for manifest.json. |
service worker file or manifest.json file for inject html
kit inject <htmlPath> [optsions]
| Option | Description |
|---|---|
| <htmlPath> | Injected html file path, this option is required. |
-mp, --manifestPath | The manifest path of being injected. |
-sp, --swPath | The service worker path of being injected |
creates a PWA project
kit init <projectPath> [optsions]
| Option | Description |
|---|---|
| <projectPath> | create a PWA project, It is best to be one empty directory |
-tpl --template | Generated project templates, currently only supporting html. |
* This command supports all options for the gen command.
upload a PWA project
kit upload <projectPath>
| Option | Description |
|---|---|
| <projectPath> | To upload a local pwa project to the service side, pathProject is the file path for the project to upload |