From eca36af7b3755f81f75b430e14eeb43edfdd55a1 Mon Sep 17 00:00:00 2001 From: Gabby Pelton Date: Fri, 29 May 2026 22:35:29 -0500 Subject: [PATCH] initialize AGENTS.md --- AGENTS.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..52236de --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,38 @@ +# LXST Client + +Single-file Python CLI for managing LXST Channel connections via Reticulum Network (RNS) and LXMF protocols. + +## Running + + python client.py [-c CONFIGDIR] [-w WHITELIST] + + Options: + -c, --config : config directory (default: ~/.lxst-client or /etc/lxst-client) + -w, --whitelist: path to bridge_whitelist.json + -v, --verbose : enable debug logging + --rnsconfig : alternative Reticulum config directory + +## Commands + + python client.py -c /etc/lxst-client -w /etc/lxst-client/bridge_whitelist.json + + Inside the interactive client: + d Discover channels from whitelist + l List discovered channels + Connect to channel at index NUM (1-based) + q Quit + +## Initial Setup Order + + 1. Ensure ~/.lxst-client or /etc/lxst-client exists + 2. Place bridge_whitelist.json in either directory (or pass with -w) + 3. First run creates identity automatically at configdir/identity + 4. Run `python client.py` then `d` to discover channels + 5. Messages appear in configdir/lxmf/ + +## Known quirks + + - If bridge_whitelist.json is missing, client prints an error and returns. + - Identity is auto-generated on first run if not present. + - 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.