docs: surface INSTALL entrypoint / 在 README 與 HANDOFF 補 INSTALL 入口
This commit is contained in:
17
HANDOFF.md
17
HANDOFF.md
@@ -37,14 +37,15 @@ This is not yet a clean cross-agent installable package. It is a successful PoC
|
|||||||
|
|
||||||
Read these files first:
|
Read these files first:
|
||||||
|
|
||||||
1. `README.md`
|
1. `INSTALL.md`
|
||||||
2. `telegram-v1-design.md`
|
2. `README.md`
|
||||||
3. `telegram-openclaw-poc-plan.md`
|
3. `telegram-v1-design.md`
|
||||||
4. `reports/telegram-openclaw-poc-success.md`
|
4. `telegram-openclaw-poc-plan.md`
|
||||||
5. `reports/openclaw-patch-inventory.md`
|
5. `reports/telegram-openclaw-poc-success.md`
|
||||||
6. `reports/openclaw-patch-mapping-matrix.md`
|
6. `reports/openclaw-patch-inventory.md`
|
||||||
7. `reports/next-phase-implementation-plan.md`
|
7. `reports/openclaw-patch-mapping-matrix.md`
|
||||||
8. `reports/agent-consumable-minimum.md`
|
8. `reports/next-phase-implementation-plan.md`
|
||||||
|
9. `reports/agent-consumable-minimum.md`
|
||||||
|
|
||||||
## Fastest operational entrypoints
|
## Fastest operational entrypoints
|
||||||
|
|
||||||
|
|||||||
88
INSTALL.md
Normal file
88
INSTALL.md
Normal file
@@ -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`
|
||||||
Reference in New Issue
Block a user