update blocklet cli doc & abtnode cli doc (#113)

* update: blocklet-cli docs & add zh translate

* chore: update abtnode-cli zh docs

* v0.3.3

Author: LancelotLewis

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.3 (十一月 23, 2021)
+
+- chore: update abtnode-cli zh docs
+- update: blocklet-cli docs & add zh translate
+
 ## 0.3.2 (August 10, 2021)
 
 - chore: update abtnode cli docs (#109)

blocklet.yml

@@ -1,5 +1,5 @@
 name: '@arcblock/abtnode-docs'
-version: 0.3.2
+version: 0.3.3
 description: >-
   ABT Node Documentation, a help documentation for quickly get started with ABT
   Node.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcblock/abtnode-docs",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "ABT Node Documentation, a help documentation for quickly get started with ABT Node.",
   "main": "index.js",
   "publishConfig": {

src/developer/abtnode-cli/index.zh.md

@@ -9,169 +9,188 @@ tags:
   - 'abtnode'
 ---
 
-为了方便用户使用 ABT 节点，我们为其量身定制了一个 CLI 工具：`abtnode cli`, 我们先看看它长什么样：
+ABT Node 提供了 `abtnode` 命令行工具，用于控制和管理节点。使用以下语法可以从您的终端运行 `abtnode` 命令：
 
 ```bash
-➜  ~ abtnode -h
-Usage: abtnode [options] [command]
-
-Options:
-  -V, --version              output the version number
-  -c --config [node-config]  ABT Node configuration file
-  -s --silent                Should we run in silent mode (default: false)
-                             (default: false)
-  -y --yes                   Automatic yes to prompts (default: false)
-                             (default: false)
-  -h, --help                 display help for command
-
-Commands:
-  bundle [options]           Bundle a blocklet that can run in ABT Node
-  start [options]            Start ABT Node Daemon
-  init                       Init ABT Node config
-  status                     Show ABT Node and blocklet status
-  logs                       Show ABT Node and blocklet logs
-  stop|kill [options]        Stop ABT Node and blocklets
-  info [options]             Get environment information for debugging and
-                             issue reporting
-  deploy [options] <folder>  Deploy blocklet from local directory to ABT Node
-  blocklet:init              Create an empty blocklet project
-  upgrade                    Self-Upgrade ABTNode
-  help [command]             display help for command
+abtnode [options] [command]
 ```
 
-可以看到它提供了丰富的命令供用户使用，主要的命令有：
+你可以使用 `-h` 或 `--help` 来查看所有支持的命令。
+
+### 版本
+
+查看当前 ABTNode 版本。
+
+```bash
+$ abtnode -V
+1.4.1
+```
 
-### 1. abtnode bundle [options]
+### 初始化
 
-用来打包一个 Blocklet
+启动 ABTNode 的配置。配置包含节点层级的基本属性，如端口。
 
-![](./images/abtnode-cli-2.png)
+```bash
+$ abtnode init
+? Are you sure to initialize a ABT Node instance in the current directory(/home/arcblock) Yes
+✔ ABT Node configuration is successfully generated /home/arcblock/.abtnode/abtnode.yml
+ℹ abtnode start
+```
 
-### 2. start [options]
+### 启动
 
-启动 ABT 节点
+启动 ABT Node 守护进程。
 
 ```bash
 ➜ abtnode start
-ℹ Load config from /Users/naterobinson/.abtnode.yml
-ℹ Node did from config zNKjPn1W28J6AVQdJjLhjYjmLtyvq7dSvE12
-✔ ABT Node Daemon started successfully: http://192.168.31.189/
+ℹ Node did from config zNKhyzGJfngmBvwQiwHtBinUNiwL2SE85yAE
+ℹ Load config from /data/abtnode/.abtnode/abtnode.yml
+✔ ABT Node DB Proxy ready on port 40404
+✔ ABT Node Event Hub ready on port 40407
+✔ ABT Node Updater ready on port 40405
+✔ ABT Node config updated with version 1.4.1
+✔ ABT Node state updated with version 1.4.1
+✔ Update blocklet environments success
+✔ Starting ABT Node Service... Done in 9.195s
+✔ Starting ABT Node Daemon... Done in 9.067s
 ```
 
-### 3. init
+ABT Node 必须在启动前初始化，否则启动将失败。可以通过 `--auto-init / -a` 参数来自动初始化。
+
+### 停止
 
-初始化 ABT 节点
+停止 ABT Node。该命令支持 `-f` 选项来强制停止节点。
 
 ```bash
-➜ abtnode init
+$ abtnode stop
+ℹ Node did from config zNKp3NUU4BJG7Q2aQc93oN2CVHCdK2dNU5t5
+ℹ Load config from /data/abtnode/.abtnode/abtnode.yml
+✔ Sending shutdown notification to web dashboard users Done in 2.07s
+✔ Routing engine is stopped successfully
+✔ abt-node-daemon is stopped successfully
+✔ abt-node-service is stopped successfully
+✔ abt-node-updater is stopped successfully
+✔ abt-node-db-hub is stopped successfully
+✔ abt-node-log-rotate is stopped successfully
+✔ abt-node-event-hub is stopped successfully
 ✔ Done!
-? Please name your Node ABT Node [naterobinson]
-? Give a concise description of your node Container of useful blocklets from Arc
-Block and its Developer Community
-? Which IP do you want your node to serve on? 192.168.31.189
-? Which port do you want your node to listen on? 8089
-? Choose routing engine none
-? Where does your Node fetch blocklet from? https://blocklet.arcblock.io
-? Where do you want ABT Node to store data? /Users/naterobinson/.abtnode
-? Where do you want to save config file? /Users/naterobinson/.abtnode.yml
-✔ ABT Node configuration is successfully generated /Users/naterobinson/.abtnode.yml
-ℹ Now you can start your ABT Node with the following command
-ℹ abtnode start
 ```
 
-### 4. status
+### 状态
 
-查看当前节点的状态
+查看 ABT Node 状态。
 
 ```bash
-➜ abtnode status
-ℹ Load config from /Users/naterobinson/.abtnode.yml
-ℹ Node did from config zNKmPHwdoymyz7p5AxeSR6qu7z4aRKEn5sih
+$ abtnode status
+ℹ Node did from config zNKp3NUU4BJG7Q2aQc93oN2CVHCdK2dNU5t5
+ℹ Load config from /data/abtnode/.abtnode/abtnode.yml
 
-ABT Node is: Running
+ABT Node status: Running
+ABT Node Data Directory: /data/abtnode/.abtnode
 
 Blocklets Status
-⚠ No blocklets installed yet.
+┌──────────────────────────────┬──────────┬───────────────┐
+│ Name                         │ Version  │ Status        │
+├──────────────────────────────┼──────────┼───────────────┤
+│ static-demo-blocklet         │ 1.1.10   │ installed     │
+└──────────────────────────────┴──────────┴───────────────┘
 ```
 
-### 5. logs
+### 日志
 
-查看当前节点的日志
+查看 ABT Node 和 Blocklet 的日志位置。你可以从显示的位置中查看日志文件。
 
 ```bash
-➜ abtnode logs
-ℹ Load config from /Users/naterobinson/.abtnode.yml
-ℹ Node did from config zNKmPHwdoymyz7p5AxeSR6qu7z4aRKEn5sih
+$ abtnode logs
+ℹ Node did from config zNKp3NUU4BJG7Q2aQc93oN2CVHCdK2dNU5t5
+ℹ Load config from /data/abtnode/.abtnode/abtnode.yml
 
 ABT Node Logs
-- Output: /Users/naterobinson/.abtnode/core/output.log
-- Error: /Users/naterobinson/.abtnode/core/error.log
-⚠ No blocklets installed yet.
+- Latest logs: /data/abtnode/.abtnode/logs/_abtnode/daemon-2021-08-03.log
+- Daemon Logs Directory: /data/abtnode/.abtnode/logs/_abtnode
+
+  Daemon Logs
+  - access-<date>.log: access logs rotated by day
+  - daemon-<date>.log: business logs rotated by day
+  - daemon-error-<date>.log: error logs rotated by day
+  - service.log: abtnode service logs
+  - stderr.log: stderr logs
+  - stdout.log: stdout logs
+
+[email protected]
+- Output: /data/abtnode/.abtnode/logs/static-demo-blocklet/output.log
+- Error: /data/abtnode/.abtnode/logs/static-demo-blocklet/error.log
 ```
 
-### 6. stop|kill [options]
+### 升级
 
-停止 ABT 节点
+升级 ABT Node 到最新版本。它执行所有必要的步骤，如停止当前版本，安装新版本，并启动它。
 
 ```bash
-➜ abtnode stop
-ℹ Load config from /Users/naterobinson/.abtnode.yml
-ℹ Node did from config zNKmPHwdoymyz7p5AxeSR6qu7z4aRKEn5sih
-✔ abt-node-daemon is stopped successfully
-✔ abt-node-db-hub is stopped successfully
-✔ Routing engine is stopped successfully
-✔ Done!
+$ abtnode upgrade
+ℹ Using abtnode from /home/arcblock/.local/bin/abtnode
+ℹ Checking permissions...
+Current version is 1.4.1, found latest version 1.4.4
+Begin upgrade
+ℹ Stopping ABT Node ...
+ℹ Installing ABT Node ...
+
+# Truncated for Brevity
 ```
 
-### 7. info [options]
+### 环境变量
 
-查看当前节点的信息
+打印环境信息以便调试和报告问题
 
 ```bash
-➜ abtnode info
+$ abtnode info
 
   System:
-    OS: macOS 10.15.5
-    CPU: (12) x64 Intel(R) Core(TM) i7-8850H CPU @ 2.60GHz
-    Shell: 5.7.1 - /bin/zsh
+    OS: Linux 5.10 Ubuntu 18.04.5 LTS (Bionic Beaver)
+    CPU: (6) x64 Intel(R) Core(TM) i7-8850H CPU @ 2.60GHz
+    Shell: 4.4.20 - /bin/bash
   Binaries:
-    Node: 12.7.0 - ~/.nvm/versions/node/v12.7.0/bin/node
-    Yarn: 1.22.4 - ~/.nvm/versions/node/v12.7.0/bin/yarn
-    npm: 6.10.0 - ~/.nvm/versions/node/v12.7.0/bin/npm
+    Node: 12.20.0 - /usr/bin/node
+    npm: 6.14.8 - /usr/bin/npm
   Servers:
-    Apache: 2.4.41 - /usr/sbin/apachectl
-    Nginx: 1.19.1 - /usr/local/bin/nginx
-  Virtualization:
-    Docker: 19.03.2 - /usr/local/bin/docker
-  Browsers:
-    Chrome: 84.0.4147.125
-    Safari: 13.1.1
-  npmGlobalPackages:
-    npm: 6.10.0
-    pm2: 4.4.0
-    yarn: 1.22.4
+    Nginx: 1.18.0 - /usr/sbin/nginx
 ```
 
-### 8. deploy [options] <folder>
-
-部署 blocklet
-
-![](./images/abtnode-cli-3.png)
+### 导出
 
-### 9. blocklet:init
+导出 ABT Node 的完整状态，包括 ABT Node 配置、Blocklets 配置和路由，以便可以分享。
 
-初始化一个空的 blocklet 项目
-
-![](./images/abtnode-cli-4.png)
-
-### 10. upgrade
+```bash
+$ abtnode export
+ℹ Node did from config zNKhyzGJfngmBvwQiwHtBinUNiwL2SE85yAE
+ℹ Load config from /data/abtnode/.abtnode/abtnode.yml
+⚠ Will only export the blocklets that installed from blocklet registry or url.
+✔ Copy ABT Node configurations file successfully!
+ℹ Copying blocklet data...
+✔ Copy blocklet data successfully!
+ℹ Copying other files...
+ℹ Copying routing rule files...
+ℹ No routing rule data
+ℹ Copying blocklet running data files...
+✔ Copy blocklet running data files successfully!
+ℹ Copying blocklet extras db data files...
+✔ Copy blocklet extras db data files successfully!
+✔ Copy other files successfully!
+
+✔ The exported data is in directory: /data/abtnode/exported_abtnode/.abtnode
+✔ Exported successfully!
+```
 
-升级 ABT 节点
+### 帮助
 
-![](./images/abtnode-cli-5.png)
+`help` 命令可以帮助你查看某个命令的帮助信息。同时，你也可以通过 `-h` 参数传递给子命令来获取相同的信息。
 
-### 11. help [command]
+```bash
+$ abtnode help logs
+Usage: abtnode logs [options]
 
-查看帮助命令
+Show ABT Node and blocklet logs
 
-![](./images/docs-help.png)
+Options:
+  -h, --help  display help for command
+```