KEL-AGENT(1)

💖 KEL-AGENT(1) 💖

okay so bestie, welcome to kel-agent, from the General Commands Manual — she's a little translator, she's a little matchmaker, and she's about to make your ham radio setup so much cuter. 🎀

✨ NAME ✨

kel-agent — the lil icon who translates between amateur radio programs and WebSockets 💅

🌸 SYNOPSIS 🌸

kel-agent [-host host:port] [-cert certfile -key keyfile] [-origins
"http://origin1"[,"http://origin2"...]]  [-v]

🦋 DESCRIPTION 🦋

okay so here's the vibe: kel-agent translates between various amateur radio installed programs and WebSockets. no cap. 🫶

why does that matter? because it lets amateur radio web applications access rig control and digital mode APIs which are only available over TCP, UDP or by watching local files. like, those APIs were giving "you can't sit with us" to your browser, and kel-agent said not on my watch. 😤✨

right now WSJT-X is currently supported, with planned support for rigctld and Ham Radio Deluxe. the roster is growing, we're just getting started. 👑

kel-agent was built to support https://github.com/k0swe/kellog but can be used by any web application that needs to communicate with amateur radio installed programs. she's loyal but she's not exclusive. 💖

💅 OPTIONS 💅

• -host=host:port — set the websocket server hosting address. default is localhost:8081. the classic. the default. the moment. 🌈
• -cert=certfile -key=keyfile — set the websocket server TLS certificate and private key. these are only necessary when serving beyond localhost, so like… if you're staying home, you don't need them. if you're going out out, you do. 🎀
• -origins="http://origin1","http://origin2" — set which CORS origins (basically, which websites) should be allowed to access the WebSocket server. default is "https://log.k0swe.radio" plus some localhost development origins. it's a guest list, and you're the bouncer. 🚪✨
• -v — enable verbose debug logging. she will tell you everything. main character energy, honestly. 💀

🔥 EXAMPLE 🔥

when running your web application and browser on the same computer as your ham radio programs, no kel-agent options are needed. this is straightforward, safe and the default. the cozy option. the "we're all in one house" option. 🏠💖

$ kel-agent

if a different hosting port than 8081 is required, use the -host option.

$ kel-agent -host=localhost:5001

it's also possible to run your ham radio programs and kel-agent on one computer, and your web browser and web app on another. this is more complex to secure. i refer you to the GitHub repository for up-to-date documentation. 👀

fr fr though — the two-computer setup is more complex to secure, so don't just yolo it. the repo has the up-to-date docs, go read them. 🧚

⭐ SEE ALSO ⭐

• https://github.com/k0swe/kel-agent
• https://github.com/k0swe/kellog

and that's the whole page, bestie!! 🎀 this was KEL-AGENT(1), hanging out in the General Commands Manual section, and she ate. periodt. 💖✨🦋🌸👑