docs: surface INSTALL entrypoint / 在 README 與 HANDOFF 補 INSTALL 入口

2026-05-13 21:48:38 +08:00
parent c5ed752a39
commit 6282667297
3 changed files with 101 additions and 11 deletions
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -0,0 +1,88 @@
+# INSTALL
+
+## Purpose
+
+This file is the shortest installation and verification guide for another engineering-focused agent.
+
+Use this when you want to apply the current Telegram/OpenClaw PoC to the `openclawtest` environment without reading the entire project history first.
+
+## Target environment
+
+Current supported target:
+
+- `openclawtest`
+- Telegram-only
+
+This is **not** yet a general package installer for arbitrary environments.
+
+## Prerequisites
+
+- access to this repo
+- access to the `openclawtest` environment on the same machine
+- permission to run the provided scripts
+
+## Install / refresh
+
+Fastest path:
+
+```bash
+bash scripts/install-openclawtest-poc.sh
+```
+
+This does two things:
+
+1. refreshes the live `openclawtest` PoC by reapplying the patch and restarting the gateway
+2. runs a verification pass over the live state and runtime markers
+
+## Manual paths
+
+### Apply patch only
+
+```bash
+bash scripts/apply-openclaw-poc-patch.sh /home/openclawtest/.nvm/versions/node/v22.22.2/lib/node_modules/openclaw/dist
+```
+
+### Refresh live openclawtest runtime
+
+```bash
+bash scripts/refresh-openclawtest-poc.sh
+```
+
+### Verify current live state
+
+```bash
+bash scripts/verify-openclaw-poc.sh \
+  /home/openclawtest/.openclaw \
+  /home/openclawtest/.nvm/versions/node/v22.22.2/lib/node_modules/openclaw/dist
+```
+
+### Rollback
+
+```bash
+bash scripts/rollback-openclaw-poc-patch.sh /home/openclawtest/.nvm/versions/node/v22.22.2/lib/node_modules/openclaw/dist
+```
+
+## What success looks like
+
+After install/refresh:
+
+- gateway is running
+- patch markers exist in the live OpenClaw dist files
+- Telegram assistant replies can show reply-end buttons
+- clicking buttons can update state and UI
+
+## Validation checklist
+
+1. Send a Telegram assistant reply through `openclawtest`
+2. Confirm buttons appear
+3. Click `continue` or `stop`
+4. Confirm state/debug files appear or update:
+   - `~/.openclaw/reply-end-controls.json`
+   - `~/.openclaw/reply-end-debug.log`
+5. For stop-state validation, send a later message and confirm the assistant becomes more restrained
+
+## Read next if needed
+
+- `HANDOFF.md`
+- `INTEGRATION.md`
+- `reports/final-readiness-report.md`