@clawpilot-app/link 0.1.0 → 0.1.1

package/README.md

@@ -2,6 +2,8 @@
 
 `ClawPilot Link` is the local daemon and CLI that connects a local OpenClaw instance to ClawPilot Relay.
 
+Chinese version: [README.zh-CN.md](./README.zh-CN.md)
+
 ## Requirements
 
 - Node.js 22.14.0 or newer
@@ -15,6 +17,25 @@ npm install -g @clawpilot-app/link
 
 ClawPilot Link follows OpenClaw's runtime baseline. If your Node.js version is older than 22.14.0, the install step will stop early and ask you to upgrade first.
 
+Installing the package only adds the `clawlink` command to your computer. It does not start the Link service yet.
+
+## How to use
+
+### First-time setup
+
+1. Install the package.
+2. Run `clawlink pair`.
+3. Scan the QR code with ClawPilot App.
+4. Wait for the pairing to finish.
+
+By default, a successful `clawlink pair` will also start ClawPilot Link in the background, so you usually do not need to run a second command right away.
+
+### Daily use
+
+- If Link is already paired and running, just open ClawPilot App and use your gateway.
+- If you rebooted the computer or stopped Link earlier, run `clawlink connect --background` to bring it back online.
+- If something does not work, run `clawlink status` first, then `clawlink doctor` for a guided check.
+
 ## Common commands
 
 ```bash
@@ -26,23 +47,37 @@ clawlink qr
 clawlink restart
 ```
 
-## Update
+### `clawlink pair`
 
-```bash
-npm install -g @clawpilot-app/link@latest
-clawlink restart
-```
+Use this the first time you set up this computer. It creates a pairing QR code, waits for ClawPilot App to scan it, saves this computer's Link credentials, installs the helper skill, and then starts the Link service in the background.
 
-## Publish from this repo
+If this computer is already paired, `clawlink pair` will not create a second Link. It will simply show a new QR code so another phone or tablet can join the same Link.
 
-```bash
-npm run release -- --version 0.1.1
-```
+### `clawlink connect --background`
+
+Starts the Link service in the background. Use this when the computer has already been paired, but the background service is not currently running, such as after a reboot or after you stopped it manually.
+
+### `clawlink status`
+
+Shows the current Link status in a simple human-readable format, including whether the daemon is online, whether OpenClaw was found, and whether local network direct access is ready.
+
+### `clawlink doctor`
+
+Runs a fuller health check. This is the best command to use when Link cannot connect, when local network direct access is unavailable, or when you want clear fix suggestions before asking for help.
+
+### `clawlink qr`
 
-Or publish in one step:
+Shows a new join QR code for a computer that is already paired. Use this when you want another ClawPilot App device to join the same Link without redoing the initial setup.
+
+### `clawlink restart`
+
+Restarts the background Link service. This is useful right after updating the npm package, after changing config, or after fixing a local issue like a port conflict.
+
+## Update
 
 ```bash
-npm run release -- --version 0.1.1 --publish
+npm install -g @clawpilot-app/link@latest
+clawlink restart
 ```
 
 The npm package name is `@clawpilot-app/link`.

package/README.zh-CN.md

@@ -0,0 +1,83 @@
+# ClawPilot Link
+
+`ClawPilot Link` 是运行在用户电脑上的本地后台服务和命令行工具，用来把本机 OpenClaw 通过 ClawPilot Relay 暴露给 ClawPilot App。
+
+English version: [README.md](./README.md)
+
+## 运行要求
+
+- Node.js 22.14.0 或更高版本
+- 这台电脑上已经安装并且能正常工作的 OpenClaw
+
+## 安装
+
+```bash
+npm install -g @clawpilot-app/link
+```
+
+ClawPilot Link 跟随 OpenClaw 的运行时基线。如果当前 Node.js 版本低于 22.14.0，安装会直接停止，并提示你先升级 Node.js。
+
+安装完成后，只是把 `clawlink` 这个命令装到你的电脑里，并不会立刻启动后台服务。
+
+## 如何使用
+
+### 第一次使用
+
+1. 先安装 `@clawpilot-app/link`
+2. 执行 `clawlink pair`
+3. 用 ClawPilot App 扫描终端里的二维码
+4. 等待配对完成
+
+默认情况下，只要 `clawlink pair` 配对成功，ClawPilot Link 就会自动在后台启动，所以大多数用户第一次不需要再额外执行别的命令。
+
+### 日常使用
+
+- 如果这台电脑已经完成过配对，而且后台服务也还在运行，那么直接打开 ClawPilot App 使用即可。
+- 如果你重启过电脑，或者之前手动停止过 Link，那么执行 `clawlink connect --background` 就可以让它重新回到后台运行。
+- 如果发现连接不通，先执行 `clawlink status` 看当前状态；如果还不清楚问题在哪里，再执行 `clawlink doctor`。
+
+## 常用命令
+
+```bash
+clawlink pair
+clawlink connect --background
+clawlink status
+clawlink doctor
+clawlink qr
+clawlink restart
+```
+
+### `clawlink pair`
+
+第一次给这台电脑接入 ClawPilot 时使用。它会生成一个配对二维码，等待 ClawPilot App 扫码，保存这台电脑的 Link 凭据，安装配套 SKILL，并在成功后自动把 Link 服务拉到后台运行。
+
+如果这台电脑已经配对过了，再执行 `clawlink pair` 不会创建第二个 Link，而是直接生成一个新的二维码，让另一台手机或平板加入同一个 Link。
+
+### `clawlink connect --background`
+
+把 Link 服务启动到后台。适合已经完成配对、但当前后台服务没有运行的情况，比如刚重启完电脑，或者你之前手动把它停掉了。
+
+### `clawlink status`
+
+查看当前状态，输出内容比较简洁，适合快速确认几件事情：后台服务有没有运行、有没有找到 OpenClaw、局域网直连是否已经就绪。
+
+### `clawlink doctor`
+
+执行更完整的排查。遇到 Link 连不上、局域网直连不可用，或者你想在求助之前先看一遍修复建议时，优先执行这个命令。
+
+### `clawlink qr`
+
+为一台已经配对过的电脑重新生成“加入二维码”。当你想让另一台 ClawPilot App 设备接入同一个 Link，但又不想重做首次配对时，就用这个命令。
+
+### `clawlink restart`
+
+重启后台 Link 服务。更新 npm 包之后、修改过配置之后，或者你刚解决完本地问题（例如端口冲突）之后，都可以执行这个命令。
+
+## 更新
+
+```bash
+npm install -g @clawpilot-app/link@latest
+clawlink restart
+```
+
+npm 包名是 `@clawpilot-app/link`。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clawpilot-app/link",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "private": false,
   "description": "ClawPilot Link daemon and CLI for connecting local OpenClaw through ClawPilot Relay",
   "license": "MIT",
@@ -11,7 +11,8 @@
   "files": [
     "src",
     "scripts/check-node-version.mjs",
-    "README.md"
+    "README.md",
+    "README.zh-CN.md"
   ],
   "keywords": [
     "clawpilot",

package/src/constants.js

@@ -1 +1 @@
-export const LINK_VERSION = "0.1.0";
+export const LINK_VERSION = "0.1.1";