Skip to main content
Version: v1.0

Quick Start


Zepp OS's open capabilities include Mini Program and Watchface.

The effect of running the Mini Program.


The effect of running the Watchface.


Developers can experience more Mini Programs and Watchfaces in the "App Store" and "Watchfaces" in the Zepp App.

Getting Started

Get started quickly with Zepp Mini Program and Watchface development with the guidance in this document.

Apply for an account

First you need a Zepp account, through which you can manage the Mini Program and Watchfaces.

Go to Register Zepp Account, or use an existing Zepp account.

Zepp Mobile App and Device Preparation

Go to the app market with your phone and install the latest version of the Zepp App.

Sign in to your Zepp account in the Zepp App and follow the instructions to complete the tethering of your Zepp OS equipped device.

Create the first Watchface

We offer two ways to make Watchfaces.

The first one is to create a Watchface online in your browser via the Watchface Maker (visual interactive interface).



The Watchface Maker requires no programming experience and is designed to be very user-friendly in operation and interaction! For more usage refer to Watchface Maker - Instructions.

The second way is to create the Watchface project by way of the Zeus CLI (the same way as the Mini Program below, see Create the first Mini Program)

Create the first Mini Program

In this step, we make a series of configurations for the Mini Program development environment, install a series of development tools, and complete the creation of the first Mini Program.


This process also applies to the Watchface Zeus CLI development approach.

Installing Node.js and the code editor

Please refer to Construction of basic environment.

Installing the Zeus CLI

Zeus CLI is a command line tool for quickly creating template projects using the zeus create command.

Please refer to Zeus CLI for installation.

Install the simulator

Zepp OS simulator can help developers simulate the running performance of Mini Programs. At the same time, you can view the log of the Mini Program, which is convenient for developers to debug and greatly improve the development efficiency.


Please refer to Simulator Setup for the installation procedure.

Creating Template Projects with the Zeus CLI

zeus create hello-world

CLI interaction

Once the project is created, open the project with the code editor and you will see the template project code.

Compile Preview

Refer to Simulator - Installation and launch to install and launch the simulator.

cd /Applications/ && sudo -s ./simulator

The simulator communication depends on the virtual network interface card tun/tap, which requires sudo privileges to run, so you need to use the sudo command to run the simulator.

After starting the simulator, refer to Simulator - Install and open "Device Simulator" to complete the installation and launch of "Device Simulator".



Execute zeus dev compile preview command at the root of the template project hello-world and the Zeus CLI will compile the project code and preview it through the simulator.

zeus dev

You can preview hello-world Mini Program in the Device Simulator.

hello world preview

For a real machine preview, please refer to Zeus CLI Real Machine Preview.

Congratulations 🎉🎉🎉🎉, you have successfully created your first Mini Program.

In addition to the template project, a series of sample Mini Programs and Watchfaces are available for developers to reference.

For more specific details on the framework and API, please refer to the corresponding reference documents.

For more details on development and debugging, please refer to.

For more details on the release of Mini Programs and Watchfaces, please refer to.