docs: update README and SKILL.md - document update system, rename binaries
This commit is contained in:
parent
bd1835f5a3
commit
9c429ce20e
2 changed files with 23 additions and 8 deletions
17
README.md
17
README.md
|
|
@ -31,8 +31,8 @@ irm https://raw.githubusercontent.com/agent-helios/helios-remote/master/scripts/
|
||||||
```
|
```
|
||||||
AI Agent
|
AI Agent
|
||||||
│
|
│
|
||||||
▼ remote CLI
|
▼ helios-remote-cli
|
||||||
helios-server ──WebSocket── helios-client (Windows)
|
helios-remote-relay ──WebSocket── helios-remote-client (Windows)
|
||||||
```
|
```
|
||||||
|
|
||||||
1. The **Windows client** connects to the relay server via WebSocket and registers with its device label.
|
1. The **Windows client** connects to the relay server via WebSocket and registers with its device label.
|
||||||
|
|
@ -62,11 +62,22 @@ remote clipboard-get <device> # get clipboard text
|
||||||
remote clipboard-set <device> <text> # set clipboard text
|
remote clipboard-set <device> <text> # set clipboard text
|
||||||
remote upload <device> <local> <remote> # upload file to device
|
remote upload <device> <local> <remote> # upload file to device
|
||||||
remote download <device> <remote> <local> # download file from device
|
remote download <device> <remote> <local> # download file from device
|
||||||
remote version <device> # compare relay/helios/client commits
|
remote version <device> # compare latest/relay/cli/client commits
|
||||||
|
remote update <device> # update all components to latest version
|
||||||
remote logs <device> # fetch last 20 lines of client log (default)
|
remote logs <device> # fetch last 20 lines of client log (default)
|
||||||
remote logs <device> --lines 200 # custom line count
|
remote logs <device> --lines 200 # custom line count
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Update System
|
||||||
|
|
||||||
|
`remote update <device>` checks `version.json` on the download server for the latest available commit and updates any component that's behind:
|
||||||
|
|
||||||
|
- **Relay** — downloads new binary, replaces itself, restarts via systemd
|
||||||
|
- **Client** — downloads new binary, replaces itself, relaunches automatically
|
||||||
|
- **CLI** — downloads new binary, replaces itself, re-executes the update command
|
||||||
|
|
||||||
|
CI publishes new binaries after every push to `master` but does **not** auto-restart the relay. Updates only happen when explicitly triggered via `remote update`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Server Setup
|
## Server Setup
|
||||||
|
|
|
||||||
14
SKILL.md
14
SKILL.md
|
|
@ -73,12 +73,16 @@ $SKILL_DIR/helios clipboard-set moritz-pc "Text for clipboard"
|
||||||
$SKILL_DIR/helios upload moritz-pc /tmp/local.txt "C:\Users\Moritz\Desktop\remote.txt"
|
$SKILL_DIR/helios upload moritz-pc /tmp/local.txt "C:\Users\Moritz\Desktop\remote.txt"
|
||||||
$SKILL_DIR/helios download moritz-pc "C:\Users\Moritz\file.txt" /tmp/downloaded.txt
|
$SKILL_DIR/helios download moritz-pc "C:\Users\Moritz\file.txt" /tmp/downloaded.txt
|
||||||
|
|
||||||
# Version: compare relay + remote + client commits (are they in sync?)
|
# Version: compare latest available vs running commits (relay / cli / client)
|
||||||
$SKILL_DIR/helios version moritz-pc
|
$SKILL_DIR/remote version moritz-pc
|
||||||
|
|
||||||
# Client log (last 100 lines, --lines for more)
|
# Update: bring all components (relay, cli, client) to latest version
|
||||||
$SKILL_DIR/helios logs moritz-pc
|
# CI publishes new binaries but does NOT auto-restart — this triggers the actual update
|
||||||
$SKILL_DIR/helios logs moritz-pc --lines 200
|
$SKILL_DIR/remote update moritz-pc
|
||||||
|
|
||||||
|
# Client log (last 20 lines by default, --lines for more)
|
||||||
|
$SKILL_DIR/remote logs moritz-pc
|
||||||
|
$SKILL_DIR/remote logs moritz-pc --lines 200
|
||||||
```
|
```
|
||||||
|
|
||||||
## Typical Workflow: UI Task
|
## Typical Workflow: UI Task
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue