go-reticulum

Go port (parity-focused) of the original Reticulum project.

This repository is maintained as a practical parity port: behaviour and public utilities are compared against the Python Reticulum reference, and remaining differences are tracked in PARITY_*.md. A significant part of the work was/is done with AI assistance (Codex/LLMs) for reading the reference implementation, creating parity TODOs, writing tests, and porting examples/CLI tooling.

The port is developed by a single maintainer with assistance from ChatGPT 5.1/5.2. Even though the project is covered with unit tests, integration tests, and smoke checks, unstable areas may still exist; if you run into one, please open an issue or contact the maintainer.

• Port Reticulum to Go with maximum behavioural parity.
• Keep the project testable: unit tests and selected integration tests.
• Provide CLI utilities compatible in spirit with the original ones (rnstatus, rnpath, rnid, etc.).

• rns/ — core library (network stack and protocols).
• cmd/ — CLI utilities (the Go equivalents of Reticulum’s “official” tools).
• examples/ — ports of Python examples (small demo programs).

Requires Go (recommended: current stable version).

Prefer using prebuilt binaries from Releases if you don’t want to build from source.

1. Start the daemon (shared instance):

go run ./cmd/rnsd -v

2. In another terminal, view status:

go run ./cmd/rnstatus -a

If you use a non-default config directory, pass it to every tool:

CFG="$HOME/.reticulum-go"
go run ./cmd/rnsd -config "$CFG" -v
go run ./cmd/rnstatus -config "$CFG" -a

Quick run without building:

go run ./cmd/rnsd --help
go run ./cmd/rnstatus --help

• rnsd — Reticulum daemon / shared instance runner. See cmd/rnsd/README.md.
• rnstatus — status display for interfaces and transport. See cmd/rnstatus/README.md.
• rnpath — path discovery and path table management. See cmd/rnpath/README.md.
• rnprobe — probe/RTT utility using receipts. See cmd/rnprobe/README.md.
• rnid — identity and crypto utility (generate/announce/encrypt/sign). See cmd/rnid/README.md.
• rnx — remote execution (listener/client, ACL, interactive mode). See cmd/rnx/README.md.
• rncp — file transfer (send/receive/fetch, ACL). See cmd/rncp/README.md.
• rnir — identity resolver stub / Reticulum initialiser (parity placeholder). See cmd/rnir/README.md.
• rnodeconf — RNode firmware/config tool (hardware-dependent). See cmd/rnodeconf/README.md.

Build a single tool:

go build -o ./bin/rnstatus ./cmd/rnstatus
./bin/rnstatus --help

• minimal — smallest possible init + announce loop. See examples/minimal/README.md.
• announce — destination announces + announce handler. See examples/announce/README.md.
• broadcast — plain destination “channel” broadcast. See examples/broadcast/README.md.
• link — basic link establishment + packet exchange. See examples/link/README.md.
• identify — link identification (Link.Identify) demo. See examples/identify/README.md.
• echo — receipts/proofs + RTT measurement. See examples/echo/README.md.
• ratchets — destination ratchets demo. See examples/ratchets/README.md.
• channel — message-based Channel over Link. See examples/channel/README.md.
• buffer — buffered read/write over Link Channel. See examples/buffer/README.md.
• request — request/response handlers over Link. See examples/request/README.md.
• resource — large transfers via Resource. See examples/resource/README.md.
• filetransfer — directory listing + file download over Resource. See examples/filetransfer/README.md.
• speedtest — link throughput measurement. See examples/speedtest/README.md.
• interface — add a custom interface programmatically (serial). See examples/interface/README.md.

Quick run:

go run ./examples/minimal --help
go run ./examples/link --help

• PARITY_*.md files contain the remaining parity TODOs vs Python Reticulum (no unrelated wishlists).
• Ideally, each parity item is closed by a code change plus a test/verification step.
• Note: the Python Reticulum supports “external interfaces” by loading <Type>.py modules from interfacepath. The Go port does not execute/load those Python modules; if such a file exists, startup will error to avoid silently running with a placeholder interface.

This is a work-in-progress port: APIs, protocols, and CLI behaviour can change as parity improves.

• Monero: 41uoDd1PNKm7j4LaBHHZ77ZPbEwEJzaRHhjEqFtKLZeWjd4sNfs3mtpbw1mcQrnNLBKWSJgui9ELEUz217Ui6kF13SmF4t5

MIT – see LICENSE.