# create-zos

> create-zos cli

Latest version **1.0.8** (published 2024-05-21) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install create-zos
pnpm add create-zos
yarn add create-zos
bun add create-zos
```

Provides the commands `zos`, `create-zos`.

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2024-05-21 |
| First published | 2024-05-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18.0.0 |
| Dependencies | 9 |
| Unpacked size | 894.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | huangtao1@zepp.com |
| Maintainers | zepp-ancy-yang |
| Keywords | zos, zepp os, ZeppOS, cli |

## Links

- npm: https://www.npmjs.com/package/create-zos
- Repository: https://github.com/zepp-health/create-zos
- Issues: https://github.com/zepp-health/create-zos/issues
- npm.io page: https://npm.io/package/create-zos

## Dependencies (9)

- [chalk](https://npm.io/package/chalk.md) ^5.3.0
- [debug](https://npm.io/package/debug.md) ^4.3.4
- [pathe](https://npm.io/package/pathe.md) ^1.1.2
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^3
- [generator-zos](https://npm.io/package/generator-zos.md) ^1.0.7
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^7.1.1
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^6
- [yeoman-environment](https://npm.io/package/yeoman-environment.md) ^4.4.0
- [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) ^5

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.8 (latest) — 2024-05-21
- 1.0.7 — 2024-05-09
- 1.0.4 — 2024-05-07
- 1.0.3 — 2024-05-07
- 1.0.2 — 2024-05-07
- 1.0.1 — 2024-05-07

## README

create-zos <a href="https://npmjs.com/package/create-zos"><img src="https://img.shields.io/npm/v/create-zos" alt="npm package"></a>
=================

Scaffolding Your First Zepp OS Application Project

> **Compatibility Note:**
> create-zos requires [Node.js](https://nodejs.org/en/) version 18+, 20+. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.

With NPM:

```bash
$ npm create zos@latest create
#or
$ npm create zos@latest app

```

With Yarn:

```bash
$ yarn create zos create
#or
$ yarn create zos app

```

With PNPM:

```bash
$ pnpm create zos create
#or
$ pnpm create zos app

```

With Bun:

```bash
$ bun create zos create
#or
$ bun create zos app

```

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a zml project, run:

```bash
// npm 7+, extra double-dash is needed:
npm create zos@latest app my-zos-app -- --template vanilla-zml

yarn create zos app my-zos-app --template vanilla-zml

pnpm create zos app my-zos-app --template vanilla-zml

bun create zos app my-zos-app --template vanilla-zml

```

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g create-zos
$ create-zos COMMAND
running command...
$ create-zos (--version)
create-zos/1.0.8 darwin-x64 node-v20.11.1
$ create-zos --help [COMMAND]
USAGE
  $ create-zos COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`create-zos app [APPPATH]`](#create-zos-app-apppath)
* [`create-zos create [APPPATH]`](#create-zos-create-apppath)
* [`create-zos help [COMMAND]`](#create-zos-help-command)
* [`create-zos module`](#create-zos-module)
* [`create-zos module ae`](#create-zos-module-ae)
* [`create-zos module ae add MODULEPATH`](#create-zos-module-ae-add-modulepath)
* [`create-zos module ae remove MODULEPATH`](#create-zos-module-ae-remove-modulepath)
* [`create-zos module app-event`](#create-zos-module-app-event)
* [`create-zos module app-event add MODULEPATH`](#create-zos-module-app-event-add-modulepath)
* [`create-zos module app-event remove MODULEPATH`](#create-zos-module-app-event-remove-modulepath)
* [`create-zos module app-service`](#create-zos-module-app-service)
* [`create-zos module app-service add MODULEPATH`](#create-zos-module-app-service-add-modulepath)
* [`create-zos module app-service remove MODULEPATH`](#create-zos-module-app-service-remove-modulepath)
* [`create-zos module app-side`](#create-zos-module-app-side)
* [`create-zos module app-side add MODULEPATH`](#create-zos-module-app-side-add-modulepath)
* [`create-zos module app-side remove MODULEPATH`](#create-zos-module-app-side-remove-modulepath)
* [`create-zos module app-widget`](#create-zos-module-app-widget)
* [`create-zos module app-widget add MODULEPATH`](#create-zos-module-app-widget-add-modulepath)
* [`create-zos module app-widget remove MODULEPATH`](#create-zos-module-app-widget-remove-modulepath)
* [`create-zos module as`](#create-zos-module-as)
* [`create-zos module as add MODULEPATH`](#create-zos-module-as-add-modulepath)
* [`create-zos module as remove MODULEPATH`](#create-zos-module-as-remove-modulepath)
* [`create-zos module aw`](#create-zos-module-aw)
* [`create-zos module aw add MODULEPATH`](#create-zos-module-aw-add-modulepath)
* [`create-zos module aw remove MODULEPATH`](#create-zos-module-aw-remove-modulepath)
* [`create-zos module data-widget`](#create-zos-module-data-widget)
* [`create-zos module data-widget add MODULEPATH`](#create-zos-module-data-widget-add-modulepath)
* [`create-zos module data-widget remove MODULEPATH`](#create-zos-module-data-widget-remove-modulepath)
* [`create-zos module dw`](#create-zos-module-dw)
* [`create-zos module dw add MODULEPATH`](#create-zos-module-dw-add-modulepath)
* [`create-zos module dw remove MODULEPATH`](#create-zos-module-dw-remove-modulepath)
* [`create-zos module page`](#create-zos-module-page)
* [`create-zos module page add MODULEPATH`](#create-zos-module-page-add-modulepath)
* [`create-zos module page remove MODULEPATH`](#create-zos-module-page-remove-modulepath)
* [`create-zos module secondary-widget`](#create-zos-module-secondary-widget)
* [`create-zos module secondary-widget add MODULEPATH`](#create-zos-module-secondary-widget-add-modulepath)
* [`create-zos module secondary-widget remove MODULEPATH`](#create-zos-module-secondary-widget-remove-modulepath)
* [`create-zos module setting`](#create-zos-module-setting)
* [`create-zos module setting add MODULEPATH`](#create-zos-module-setting-add-modulepath)
* [`create-zos module setting remove MODULEPATH`](#create-zos-module-setting-remove-modulepath)
* [`create-zos module side`](#create-zos-module-side)
* [`create-zos module side add MODULEPATH`](#create-zos-module-side-add-modulepath)
* [`create-zos module side remove MODULEPATH`](#create-zos-module-side-remove-modulepath)
* [`create-zos module ss`](#create-zos-module-ss)
* [`create-zos module ss add MODULEPATH`](#create-zos-module-ss-add-modulepath)
* [`create-zos module ss remove MODULEPATH`](#create-zos-module-ss-remove-modulepath)
* [`create-zos module sw`](#create-zos-module-sw)
* [`create-zos module sw add MODULEPATH`](#create-zos-module-sw-add-modulepath)
* [`create-zos module sw remove MODULEPATH`](#create-zos-module-sw-remove-modulepath)
* [`create-zos module watchface`](#create-zos-module-watchface)
* [`create-zos module watchface add MODULEPATH`](#create-zos-module-watchface-add-modulepath)
* [`create-zos module watchface remove MODULEPATH`](#create-zos-module-watchface-remove-modulepath)
* [`create-zos module wf`](#create-zos-module-wf)
* [`create-zos module wf add MODULEPATH`](#create-zos-module-wf-add-modulepath)
* [`create-zos module wf remove MODULEPATH`](#create-zos-module-wf-remove-modulepath)
* [`create-zos plugins`](#create-zos-plugins)
* [`create-zos plugins add PLUGIN`](#create-zos-plugins-add-plugin)
* [`create-zos plugins:inspect PLUGIN...`](#create-zos-pluginsinspect-plugin)
* [`create-zos plugins install PLUGIN`](#create-zos-plugins-install-plugin)
* [`create-zos plugins link PATH`](#create-zos-plugins-link-path)
* [`create-zos plugins remove [PLUGIN]`](#create-zos-plugins-remove-plugin)
* [`create-zos plugins reset`](#create-zos-plugins-reset)
* [`create-zos plugins uninstall [PLUGIN]`](#create-zos-plugins-uninstall-plugin)
* [`create-zos plugins unlink [PLUGIN]`](#create-zos-plugins-unlink-plugin)
* [`create-zos plugins update`](#create-zos-plugins-update)

## `create-zos app [APPPATH]`

Create project from template

```
USAGE
  $ create-zos app [APPPATH] [--template <value>] [--Type |watchface|workout] [--apiLevel 3.0|3.6]

ARGUMENTS
  APPPATH  [default: .] project dir

FLAGS
  --apiLevel=<option>  [default: 3.6] api level
                       <options: 3.0|3.6>
  --appType=<option>   [default: app] app type
                       <options: app|watchface|workout>
  --template=<value>   template project

DESCRIPTION
  Create project from template

ALIASES
  $ create-zos app

EXAMPLES
  $  create-zos app my-app-dir --template=vanilla --appType=app --apiLevel=3.6
```

## `create-zos create [APPPATH]`

Create project from template

```
USAGE
  $ create-zos create [APPPATH] [--template <value>] [--appType app|watchface|workout] [--apiLevel 3.0|3.6]

ARGUMENTS
  APPPATH  [default: .] project dir

FLAGS
  --apiLevel=<option>  [default: 3.6] api level
                       <options: 3.0|3.6>
  --appType=<option>   [default: app] app type
                       <options: app|watchface|workout>
  --template=<value>   template project

DESCRIPTION
  Create project from template

ALIASES
  $ create-zos app

EXAMPLES
  $  create-zos create my-app-dir --template=vanilla --appType=app --apiLevel=3.6
```

_See code: [src/commands/create/index.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/create/index.ts)_

## `create-zos help [COMMAND]`

Display help for create-zos.

```
USAGE
  $ create-zos help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for create-zos.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.21/src/commands/help.ts)_

## `create-zos module`

Create or Remove module in project

```
USAGE
  $ create-zos module

DESCRIPTION
  Create or Remove module in project

EXAMPLES
  $  create-zos module page --help
```

_See code: [src/commands/module/index.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/index.ts)_

## `create-zos module ae`

Create App Event

```
USAGE
  $ create-zos module ae

DESCRIPTION
  Create App Event

ALIASES
  $ create-zos module ae

EXAMPLES
  $  create-zos module ae --help
```

## `create-zos module ae add MODULEPATH`

Add app-event module in project

```
USAGE
  $ create-zos module ae add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  app-event path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  app-event template

DESCRIPTION
  Add app-event module in project

ALIASES
  $ create-zos module ae add

EXAMPLES
  $ create-zos module ae add home/welcome --template=vanilla
```

## `create-zos module ae remove MODULEPATH`

Remove app-event module in project

```
USAGE
  $ create-zos module ae remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  app-event path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove app-event module in project

ALIASES
  $ create-zos module ae remove

EXAMPLES
  $ create-zos module ae remove home/welcome
```

## `create-zos module app-event`

Create App Event

```
USAGE
  $ create-zos module app-event

DESCRIPTION
  Create App Event

ALIASES
  $ create-zos module ae

EXAMPLES
  $  create-zos module app-event --help
```

_See code: [src/commands/module/app-event/index.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/app-event/index.ts)_

## `create-zos module app-event add MODULEPATH`

Add app-event module in project

```
USAGE
  $ create-zos module app-event add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  app-event path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  app-event template

DESCRIPTION
  Add app-event module in project

ALIASES
  $ create-zos module ae add

EXAMPLES
  $ create-zos module app-event add home/welcome --template=vanilla
```

_See code: [src/commands/module/app-event/add.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/app-event/add.ts)_

## `create-zos module app-event remove MODULEPATH`

Remove app-event module in project

```
USAGE
  $ create-zos module app-event remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  app-event path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove app-event module in project

ALIASES
  $ create-zos module ae remove

EXAMPLES
  $ create-zos module app-event remove home/welcome
```

_See code: [src/commands/module/app-event/remove.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/app-event/remove.ts)_

## `create-zos module app-service`

Create App Service

```
USAGE
  $ create-zos module app-service

DESCRIPTION
  Create App Service

ALIASES
  $ create-zos module as

EXAMPLES
  $  create-zos module app-service --help
```

_See code: [src/commands/module/app-service/index.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/app-service/index.ts)_

## `create-zos module app-service add MODULEPATH`

Add app-service module in project

```
USAGE
  $ create-zos module app-service add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  app-service path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  app-service template

DESCRIPTION
  Add app-service module in project

ALIASES
  $ create-zos module as add

EXAMPLES
  $ create-zos module app-service add home/welcome --template=vanilla
```

_See code: [src/commands/module/app-service/add.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/app-service/add.ts)_

## `create-zos module app-service remove MODULEPATH`

Remove app-service module in project

```
USAGE
  $ create-zos module app-service remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  app-service path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove app-service module in project

ALIASES
  $ create-zos module as remove

EXAMPLES
  $ create-zos module app-service remove home/welcome
```

_See code: [src/commands/module/app-service/remove.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/app-service/remove.ts)_

## `create-zos module app-side`

Create App SideService

```
USAGE
  $ create-zos module app-side

DESCRIPTION
  Create App SideService

ALIASES
  $ create-zos module side
  $ create-zos module ss

EXAMPLES
  $  create-zos module app-side --help
```

_See code: [src/commands/module/app-side/index.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/app-side/index.ts)_

## `create-zos module app-side add MODULEPATH`

Add app-side module in project

```
USAGE
  $ create-zos module app-side add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  app-side path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  app-side template

DESCRIPTION
  Add app-side module in project

ALIASES
  $ create-zos module side add
  $ create-zos module ss add

EXAMPLES
  $ create-zos module app-side add home/welcome --template=vanilla
```

_See code: [src/commands/module/app-side/add.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/app-side/add.ts)_

## `create-zos module app-side remove MODULEPATH`

Remove app-event module in project

```
USAGE
  $ create-zos module app-side remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  app-side path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove app-event module in project

ALIASES
  $ create-zos module side remove
  $ create-zos module ss remove

EXAMPLES
  $ create-zos module app-side remove home/welcome
```

_See code: [src/commands/module/app-side/remove.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/app-side/remove.ts)_

## `create-zos module app-widget`

Create App Widget

```
USAGE
  $ create-zos module app-widget

DESCRIPTION
  Create App Widget

ALIASES
  $ create-zos module aw

EXAMPLES
  $  create-zos module app-widget --help
```

_See code: [src/commands/module/app-widget/index.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/app-widget/index.ts)_

## `create-zos module app-widget add MODULEPATH`

Add app-widget module in project

```
USAGE
  $ create-zos module app-widget add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  app-side path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  app-widget template

DESCRIPTION
  Add app-widget module in project

ALIASES
  $ create-zos module aw add

EXAMPLES
  $ create-zos module app-widget add home/welcome --template=vanilla
```

_See code: [src/commands/module/app-widget/add.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/app-widget/add.ts)_

## `create-zos module app-widget remove MODULEPATH`

Remove app-widget module in project

```
USAGE
  $ create-zos module app-widget remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  app-side path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove app-widget module in project

ALIASES
  $ create-zos module aw remove

EXAMPLES
  $ create-zos module app-widget remove home/welcome
```

_See code: [src/commands/module/app-widget/remove.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/app-widget/remove.ts)_

## `create-zos module as`

Create App Service

```
USAGE
  $ create-zos module as

DESCRIPTION
  Create App Service

ALIASES
  $ create-zos module as

EXAMPLES
  $  create-zos module as --help
```

## `create-zos module as add MODULEPATH`

Add app-service module in project

```
USAGE
  $ create-zos module as add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  app-service path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  app-service template

DESCRIPTION
  Add app-service module in project

ALIASES
  $ create-zos module as add

EXAMPLES
  $ create-zos module as add home/welcome --template=vanilla
```

## `create-zos module as remove MODULEPATH`

Remove app-service module in project

```
USAGE
  $ create-zos module as remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  app-service path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove app-service module in project

ALIASES
  $ create-zos module as remove

EXAMPLES
  $ create-zos module as remove home/welcome
```

## `create-zos module aw`

Create App Widget

```
USAGE
  $ create-zos module aw

DESCRIPTION
  Create App Widget

ALIASES
  $ create-zos module aw

EXAMPLES
  $  create-zos module aw --help
```

## `create-zos module aw add MODULEPATH`

Add app-widget module in project

```
USAGE
  $ create-zos module aw add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  app-side path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  app-widget template

DESCRIPTION
  Add app-widget module in project

ALIASES
  $ create-zos module aw add

EXAMPLES
  $ create-zos module aw add home/welcome --template=vanilla
```

## `create-zos module aw remove MODULEPATH`

Remove app-widget module in project

```
USAGE
  $ create-zos module aw remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  app-side path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove app-widget module in project

ALIASES
  $ create-zos module aw remove

EXAMPLES
  $ create-zos module aw remove home/welcome
```

## `create-zos module data-widget`

Create Data Widget

```
USAGE
  $ create-zos module data-widget

DESCRIPTION
  Create Data Widget

ALIASES
  $ create-zos module dw

EXAMPLES
  $  create-zos module data-widget --help
```

_See code: [src/commands/module/data-widget/index.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/data-widget/index.ts)_

## `create-zos module data-widget add MODULEPATH`

Add data-widget module in project

```
USAGE
  $ create-zos module data-widget add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  data-widget path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  data-widget template

DESCRIPTION
  Add data-widget module in project

ALIASES
  $ create-zos module dw add

EXAMPLES
  $ create-zos module data-widget add home/welcome --template=vanilla
```

_See code: [src/commands/module/data-widget/add.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/data-widget/add.ts)_

## `create-zos module data-widget remove MODULEPATH`

Remove data-widget module in project

```
USAGE
  $ create-zos module data-widget remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  data-widget path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove data-widget module in project

ALIASES
  $ create-zos module dw remove

EXAMPLES
  $ create-zos module data-widget remove home/welcome
```

_See code: [src/commands/module/data-widget/remove.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/data-widget/remove.ts)_

## `create-zos module dw`

Create Data Widget

```
USAGE
  $ create-zos module dw

DESCRIPTION
  Create Data Widget

ALIASES
  $ create-zos module dw

EXAMPLES
  $  create-zos module dw --help
```

## `create-zos module dw add MODULEPATH`

Add data-widget module in project

```
USAGE
  $ create-zos module dw add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  data-widget path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  data-widget template

DESCRIPTION
  Add data-widget module in project

ALIASES
  $ create-zos module dw add

EXAMPLES
  $ create-zos module dw add home/welcome --template=vanilla
```

## `create-zos module dw remove MODULEPATH`

Remove data-widget module in project

```
USAGE
  $ create-zos module dw remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  data-widget path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove data-widget module in project

ALIASES
  $ create-zos module dw remove

EXAMPLES
  $ create-zos module dw remove home/welcome
```

## `create-zos module page`

Create Page

```
USAGE
  $ create-zos module page

DESCRIPTION
  Create Page

EXAMPLES
  $  create-zos module page --help
```

_See code: [src/commands/module/page/index.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/page/index.ts)_

## `create-zos module page add MODULEPATH`

Add page module in project

```
USAGE
  $ create-zos module page add MODULEPATH [-f] [--template <value>] [--with-pin]

ARGUMENTS
  MODULEPATH  page path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  page template
      --with-pin          add page to first position

DESCRIPTION
  Add page module in project

EXAMPLES
  $ create-zos module page add home/welcome --template=vanilla
```

_See code: [src/commands/module/page/add.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/page/add.ts)_

## `create-zos module page remove MODULEPATH`

Remove page module in project

```
USAGE
  $ create-zos module page remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  page path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove page module in project

EXAMPLES
  $ create-zos module page remove home/welcome
```

_See code: [src/commands/module/page/remove.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/page/remove.ts)_

## `create-zos module secondary-widget`

Create Secondary Widget

```
USAGE
  $ create-zos module secondary-widget

DESCRIPTION
  Create Secondary Widget

ALIASES
  $ create-zos module sw

EXAMPLES
  $  create-zos module secondary-widget --help
```

_See code: [src/commands/module/secondary-widget/index.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/secondary-widget/index.ts)_

## `create-zos module secondary-widget add MODULEPATH`

Add secondary-widget module in project

```
USAGE
  $ create-zos module secondary-widget add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  secondary-widget path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  secondary-widget template

DESCRIPTION
  Add secondary-widget module in project

ALIASES
  $ create-zos module sw add

EXAMPLES
  $ create-zos module secondary-widget add home/welcome --template=vanilla
```

_See code: [src/commands/module/secondary-widget/add.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/secondary-widget/add.ts)_

## `create-zos module secondary-widget remove MODULEPATH`

Remove secondary-widget module in project

```
USAGE
  $ create-zos module secondary-widget remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  secondary-widget path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove secondary-widget module in project

ALIASES
  $ create-zos module sw remove

EXAMPLES
  $ create-zos module secondary-widget remove home/welcome
```

_See code: [src/commands/module/secondary-widget/remove.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/secondary-widget/remove.ts)_

## `create-zos module setting`

Create App Setting

```
USAGE
  $ create-zos module setting

DESCRIPTION
  Create App Setting

EXAMPLES
  $  create-zos module setting --help
```

_See code: [src/commands/module/setting/index.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/setting/index.ts)_

## `create-zos module setting add MODULEPATH`

Add setting module in project

```
USAGE
  $ create-zos module setting add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  setting path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  setting template

DESCRIPTION
  Add setting module in project

EXAMPLES
  $ create-zos module setting add home/welcome --template=vanilla
```

_See code: [src/commands/module/setting/add.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/setting/add.ts)_

## `create-zos module setting remove MODULEPATH`

Remove setting module in project

```
USAGE
  $ create-zos module setting remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  setting path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove setting module in project

EXAMPLES
  $ create-zos module setting remove home/welcome
```

_See code: [src/commands/module/setting/remove.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/setting/remove.ts)_

## `create-zos module side`

Create App SideService

```
USAGE
  $ create-zos module side

DESCRIPTION
  Create App SideService

ALIASES
  $ create-zos module side
  $ create-zos module ss

EXAMPLES
  $  create-zos module side --help
```

## `create-zos module side add MODULEPATH`

Add app-side module in project

```
USAGE
  $ create-zos module side add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  app-side path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  app-side template

DESCRIPTION
  Add app-side module in project

ALIASES
  $ create-zos module side add
  $ create-zos module ss add

EXAMPLES
  $ create-zos module side add home/welcome --template=vanilla
```

## `create-zos module side remove MODULEPATH`

Remove app-event module in project

```
USAGE
  $ create-zos module side remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  app-side path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove app-event module in project

ALIASES
  $ create-zos module side remove
  $ create-zos module ss remove

EXAMPLES
  $ create-zos module side remove home/welcome
```

## `create-zos module ss`

Create App SideService

```
USAGE
  $ create-zos module ss

DESCRIPTION
  Create App SideService

ALIASES
  $ create-zos module side
  $ create-zos module ss

EXAMPLES
  $  create-zos module ss --help
```

## `create-zos module ss add MODULEPATH`

Add app-side module in project

```
USAGE
  $ create-zos module ss add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  app-side path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  app-side template

DESCRIPTION
  Add app-side module in project

ALIASES
  $ create-zos module side add
  $ create-zos module ss add

EXAMPLES
  $ create-zos module ss add home/welcome --template=vanilla
```

## `create-zos module ss remove MODULEPATH`

Remove app-event module in project

```
USAGE
  $ create-zos module ss remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  app-side path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove app-event module in project

ALIASES
  $ create-zos module side remove
  $ create-zos module ss remove

EXAMPLES
  $ create-zos module ss remove home/welcome
```

## `create-zos module sw`

Create Secondary Widget

```
USAGE
  $ create-zos module sw

DESCRIPTION
  Create Secondary Widget

ALIASES
  $ create-zos module sw

EXAMPLES
  $  create-zos module sw --help
```

## `create-zos module sw add MODULEPATH`

Add secondary-widget module in project

```
USAGE
  $ create-zos module sw add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  secondary-widget path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  secondary-widget template

DESCRIPTION
  Add secondary-widget module in project

ALIASES
  $ create-zos module sw add

EXAMPLES
  $ create-zos module sw add home/welcome --template=vanilla
```

## `create-zos module sw remove MODULEPATH`

Remove secondary-widget module in project

```
USAGE
  $ create-zos module sw remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  secondary-widget path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove secondary-widget module in project

ALIASES
  $ create-zos module sw remove

EXAMPLES
  $ create-zos module sw remove home/welcome
```

## `create-zos module watchface`

Create watchface

```
USAGE
  $ create-zos module watchface

DESCRIPTION
  Create watchface

ALIASES
  $ create-zos module wf

EXAMPLES
  $  create-zos module watchface --help
```

_See code: [src/commands/module/watchface/index.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/watchface/index.ts)_

## `create-zos module watchface add MODULEPATH`

Add watchface module in project

```
USAGE
  $ create-zos module watchface add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  watchface path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  watchface template

DESCRIPTION
  Add watchface module in project

ALIASES
  $ create-zos module wf add

EXAMPLES
  $ create-zos module watchface add home/welcome --template=vanilla
```

_See code: [src/commands/module/watchface/add.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/watchface/add.ts)_

## `create-zos module watchface remove MODULEPATH`

Remove watchface module in project

```
USAGE
  $ create-zos module watchface remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  watchface path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove watchface module in project

ALIASES
  $ create-zos module wf remove

EXAMPLES
  $ create-zos module watchface remove home/welcome
```

_See code: [src/commands/module/watchface/remove.ts](https://github.com/zepp-health/create-zos/blob/v1.0.8/src/commands/module/watchface/remove.ts)_

## `create-zos module wf`

Create watchface

```
USAGE
  $ create-zos module wf

DESCRIPTION
  Create watchface

ALIASES
  $ create-zos module wf

EXAMPLES
  $  create-zos module wf --help
```

## `create-zos module wf add MODULEPATH`

Add watchface module in project

```
USAGE
  $ create-zos module wf add MODULEPATH [-f] [--template <value>]

ARGUMENTS
  MODULEPATH  watchface path

FLAGS
  -f, --force             Force override existing files
      --template=<value>  watchface template

DESCRIPTION
  Add watchface module in project

ALIASES
  $ create-zos module wf add

EXAMPLES
  $ create-zos module wf add home/welcome --template=vanilla
```

## `create-zos module wf remove MODULEPATH`

Remove watchface module in project

```
USAGE
  $ create-zos module wf remove MODULEPATH [-f]

ARGUMENTS
  MODULEPATH  watchface path

FLAGS
  -f, --force  Force override existing files

DESCRIPTION
  Remove watchface module in project

ALIASES
  $ create-zos module wf remove

EXAMPLES
  $ create-zos module wf remove home/welcome
```

## `create-zos plugins`

List installed plugins.

```
USAGE
  $ create-zos plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ create-zos plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/index.ts)_

## `create-zos plugins add PLUGIN`

Installs a plugin into create-zos.

```
USAGE
  $ create-zos plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into create-zos.

  Uses bundled npm executable to install plugins into /Users/htoo/.local/share/create-zos

  Installation of a user-installed plugin will override a core plugin.

  Use the CREATE_ZOS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the CREATE_ZOS_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ create-zos plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ create-zos plugins add myplugin

  Install a plugin from a github url.

    $ create-zos plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ create-zos plugins add someuser/someplugin
```

## `create-zos plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

```
USAGE
  $ create-zos plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ create-zos plugins inspect myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/inspect.ts)_

## `create-zos plugins install PLUGIN`

Installs a plugin into create-zos.

```
USAGE
  $ create-zos plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into create-zos.

  Uses bundled npm executable to install plugins into /Users/htoo/.local/share/create-zos

  Installation of a user-installed plugin will override a core plugin.

  Use the CREATE_ZOS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the CREATE_ZOS_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ create-zos plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ create-zos plugins install myplugin

  Install a plugin from a github url.

    $ create-zos plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ create-zos plugins install someuser/someplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/install.ts)_

## `create-zos plugins link PATH`

Links a plugin into the CLI for development.

```
USAGE
  $ create-zos plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ create-zos plugins link myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/link.ts)_

## `create-zos plugins remove [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
  $ create-zos plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ create-zos plugins unlink
  $ create-zos plugins remove

EXAMPLES
  $ create-zos plugins remove myplugin
```

## `create-zos plugins reset`

Remove all user-installed and linked plugins.

```
USAGE
  $ create-zos plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/reset.ts)_

## `create-zos plugins uninstall [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
  $ create-zos plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ create-zos plugins unlink
  $ create-zos plugins remove

EXAMPLES
  $ create-zos plugins uninstall myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/uninstall.ts)_

## `create-zos plugins unlink [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
  $ create-zos plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ create-zos plugins unlink
  $ create-zos plugins remove

EXAMPLES
  $ create-zos plugins unlink myplugin
```

## `create-zos plugins update`

Update installed plugins.

```
USAGE
  $ create-zos plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.19/src/commands/plugins/update.ts)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/create-zos · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._