update AGENTS.md
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
# LXST Client
|
# LXST Client
|
||||||
|
|
||||||
Single-file Python application for managing LXST Channel connections via Reticulum Network (RNS) and LXMF protocols. Supports CLI and Whisplay HAT GUI modes.
|
Single-file Python application for managing LXST Channel connections via Reticulum Network (RNS) and LXMF protocols using the Whisplay HAT.
|
||||||
|
|
||||||
## Running
|
## Running
|
||||||
|
|
||||||
@@ -12,17 +12,6 @@ Single-file Python application for managing LXST Channel connections via Reticul
|
|||||||
-v, --verbose : enable debug logging
|
-v, --verbose : enable debug logging
|
||||||
--rnsconfig : alternative Reticulum config directory
|
--rnsconfig : alternative Reticulum config directory
|
||||||
|
|
||||||
## Whisplay GUI Controls
|
|
||||||
|
|
||||||
## CLI Commands
|
|
||||||
|
|
||||||
Inside the interactive client:
|
|
||||||
d Discover channels from whitelist
|
|
||||||
l List discovered channels
|
|
||||||
<NUM> Connect to channel at index NUM (1-based)
|
|
||||||
h / ? Show help
|
|
||||||
q Quit
|
|
||||||
|
|
||||||
## Whisplay GUI Controls
|
## Whisplay GUI Controls
|
||||||
|
|
||||||
### Channel list (STATE_READY)
|
### Channel list (STATE_READY)
|
||||||
@@ -53,9 +42,8 @@ Single-file Python application for managing LXST Channel connections via Reticul
|
|||||||
1. Ensure ~/.lxst-client or /etc/lxst-client exists
|
1. Ensure ~/.lxst-client or /etc/lxst-client exists
|
||||||
2. Place bridge_whitelist.json in either directory (or pass with -w)
|
2. Place bridge_whitelist.json in either directory (or pass with -w)
|
||||||
3. First run creates identity automatically at configdir/identity
|
3. First run creates identity automatically at configdir/identity
|
||||||
4. In CLI mode: run `python client.py` then `d` to discover channels
|
4. In GUI mode: run `python client.py -W` — auto-discovers on startup
|
||||||
5. In GUI mode: run `python client.py -W` — auto-discovers on startup
|
5. Messages appear in configdir/lxmf/
|
||||||
6. Messages appear in configdir/lxmf/
|
|
||||||
|
|
||||||
## Known quirks
|
## Known quirks
|
||||||
|
|
||||||
@@ -64,4 +52,3 @@ Single-file Python application for managing LXST Channel connections via Reticul
|
|||||||
- Use -v for RNS debug output (path discovery is verbose here).
|
- Use -v for RNS debug output (path discovery is verbose here).
|
||||||
- Path discovery waits up to 10s for relays; increase timeout in client code if needed.
|
- Path discovery waits up to 10s for relays; increase timeout in client code if needed.
|
||||||
- Whisplay mode requires Pillow and the Whisplay runtime (whisplay.py / whisplay_client.py).
|
- Whisplay mode requires Pillow and the Whisplay runtime (whisplay.py / whisplay_client.py).
|
||||||
- Falls back to CLI gracefully if Whisplay hardware or dependencies are unavailable.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user