96 lines
2.4 KiB
Markdown
96 lines
2.4 KiB
Markdown
# 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
|
|
|
|
If you are extending the feature rather than merely applying the PoC, prefer starting from these repo-side integration seams before editing runtime files directly:
|
|
|
|
- `src/adapters/openclaw-plugin-skeleton.ts`
|
|
- `src/adapters/openclaw-interactive-handler.ts`
|
|
- `src/adapters/openclaw-message-tool.ts`
|
|
- `src/adapters/openclaw-state-file.ts`
|
|
|
|
### 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`
|