CGRFETCH(1)

✨ CGRFETCH ✨

okay bestie, sit down, hydrate, because we're about to talk about cgrfetch — it's a little BP executables icon from the perl v5.24.1 era (yes, that's the manual name and the version, love that for us) and honestly? it eats. 💅

---

🎀 NAME 🎀

cgrfetch — Visualize CGR simulations

---

🌸 SYNOPSIS 🌸

cgrfetch [OPTIONS] DEST-NODE

---

🦋 DESCRIPTION 🦋

So here's the vibe: cgrfetch uses CGR to simulate sending a bundle from the local node over to DEST-NODE. It traces the execution of CGR so it can generate graphs of the routes that were considered and the routes that were ultimately chosen to forward along. And before you panic — no bundle is sent during the simulation. It's all pretend, it's all safe, it's giving dress rehearsal. 🙈

A JSON representation of the simulation gets output to OUTPUT-FILE. That representation includes the parameters of the simulation, plus a structure for each considered route, which in turn includes the calculated parameters for the route and an image of the contact graph. Like, it's thorough. It's an overachiever. We stan.

Now, the tooling tea: the dot(1) tool from the Graphviz package is used to generate those contact graph images, and it is required for cgrfetch(1). The base64(1) tool from coreutils is used to embed the images in the JSON, and it's also required. So like… go install those first, bestie. No cap. 🫶

---

💖 OPTIONS 💖

• DEST-NODE — the final destination to route to. To be useful, it should be a node that actually exists in the contact plan. (To be useless… well, you do you. 😭)
• -q — Disable trace message output. Quiet mode, shy mode, mysterious mode. 🤫
• -j — Disable JSON output.
• -m — Use a minimum-latency extended COS for the bundle. Heads up though: this ends up sending the bundle to all proximate nodes. All of them. Every single one. It's giving group chat blast. 💀
• -t DISPATCH-OFFSET — Request a dispatch time of DISPATCH-OFFSET seconds from the time the command is run (default: 0).
• -e EXPIRATION-OFFSET — Set the bundle expiration time to EXPIRATION-OFFSET seconds from the time the command is run (default: 3600).
• -s BUNDLE-SIZE — Set the bundle payload size to BUNDLE-SIZE bytes (default: 0).
• -o OUTPUT-FILE — Send JSON to OUTPUT-FILE (default: stdout).
• -p OUTDUCT-PROTO — Use OUTDUCT-PROTO as the outduct protocol (default: udp).
• -n OUTDUCT-NAME — Use OUTDUCT-NAME as the outduct name (default: *).

---

🌈 EXAMPLES 🌈

okay periodt, here's how you'd actually run it:

cgrfetch 8

Simulate CGR with destination node 8 and dispatch time equal to the current time. Iconic, simple, no notes. ✨

cgrfetch 8 -t 60

Do the same with a dispatch time 60 seconds in the future. Future you says hi. 👑

---

🔥 SEE ALSO 🔥

• dot(1)
• base64(1)

---

⭐ reminder reminder: dot(1) and base64(1) are required, not optional. The page said required and I said required. We're all on the same page. 💜

---

and that's the whole thing, bestie — this little beauty shipped as perl v5.24.1 dated 2016-07-07, which is honestly vintage-core and we love her for it. stay slaying, keep your contact plans valid, and always double-check your DEST-NODE. 🧚💖