tt-minigame-ide-cli 2.0.0-alpha.1 → 2.0.0

package/README.md

@@ -1,11 +1,150 @@
 # `tt-minigame-ide-cli`
 
-> TODO: description
+## 介绍
 
-## Usage
+开发者工具提供了命令行供外部调用，开发者可以通过命令行工具进行登录、预览、上传等操作。
 
+小游戏命令行工具已升级至 2.0.0 版本，在命令行使用方式上同 1.x.x 版本一致。默认情况下自 2.0.0 版本起，会采集部分行为数据以帮助我们了解如何更好地改进产品，您也可以通过 set-config 命令来禁止该行为。
+
+命令行工具安装方式：
+
+```js
+npm install -g tt-minigame-ide-cli
+```
+
+---
+
+## 使用
+
+### 设置全局配置
+
+主要用于配置工具的全局代理
+
+#### 命令行使用
+
+```bash
+Usage: tmg set-config [options]
+
+Set tt-ide-cli config
+
+Options:
+-p, --proxy <proxy>           Set global proxy（配置全局代理）
+--default                     Use default（恢复为默认配置）
+-r, --allow-report-event      允许采集使用行为（yes|no），默认为 yes
+```
+
+### 登录
+
+登录到开发者平台。支持代理设置。
+
+```js
+Usage: tmg login [options]
+
+Login to the developer platform
+
+Options:
+
+  -m, --mobile         Login by mobile
+
+  -e, --email          Login by email
+
+  -p, --proxy <proxy>  Login with proxy
+
+  -h, --help           output usage information
 ```
-const ttMinigameIdeCli = require('tt-minigame-ide-cli');
 
-// TODO: DEMONSTRATE API
+### 通过 email 登录
+
+```js
+Usage: tmg login-e [email] [password]
+
+Login to the developer platform by E-mail
+
+Options:
+
+  -p, --proxy <proxy>  Login with proxy
+
+  -h, --help           Output usage information
+```
+
+### 登出（清除本地 session）
+
+#### 命令行使用
+
+```bash
+Usage: tmg logout
+
+Logout and clear the session.
+```
+
+### 预览小游戏
+
+将项目上传后，扫码二维码来预览小游戏。
+
+```js
+Usage: tmg preview [options] [entry]
+
+preview project by remote
+
+Options:
+
+  -f, --force          Preview project without local cache(deprecated)
+
+  --disable-cache      Preview project without local cache
+
+  -s, --small          Use small QR Code, but it does not take effect in some environments
+
+  -u, --copy           Copy remote url to clipboard
+
+  -p, --proxy <proxy>  Preview with proxy
+
+  -h, --help           output usage information
+
+  -o, --output <path>  QRCode image output path
+```
+
+### 上传项目
+
+把项目上传到开发者平台进行发布。
+
+```js
+Usage: tmg upload [options] [entry]
+
+upload project to the developer platform
+
+Options:
+
+  -v, --app-version <version>  App version (eg: [major].[minor].[patch])
+
+  -c, --app-changelog <log>    Changelog for this version
+
+  -p, --proxy <proxy>          Update request proxy
+
+  -u, --copy                  Copy remote url to clipboard
+
+  -h, --help                   output usage information
+
+  -o, --output <path>          QRCode image output path
+```
+
+### 获取项目版本
+
+获取项目线上版本号。
+
+```js
+Usage: tmg version [entry]
+
+Get latest released version of project
+```
+
+### 构建 NPM
+
+对应开发者工具 <a href="https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/framework/npm/" target="_blank">构建 NPM</a> 功能
+
+#### 命令行使用
+
+```bash
+Usage: tmg build-npm [entry]
+
+Build npm
 ```