---
name: "cgrfetch"
section: "1"
platform: "linux"
package: "ion"
version: "3.2.1+dfsg-1.1"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/cgrfetch"
---

# cgrfetch(1)

Visualize CGR simulations

## NAME

cgrfetch - Visualize CGR simulations

## SYNOPSIS

**cgrfetch** \[*OPTIONS*\] *DEST-NODE*

## DESCRIPTION

**cgrfetch** uses CGR to simulate sending a bundle from the local node to *DEST-NODE*. It traces the execution of CGR to generate graphs of the routes that were considered and the routes that were ultimately chosen to forward along. No bundle is sent during the simulation.

A JSON representation of the simulation is output to *OUTPUT-FILE*. The representation includes parameters of the simulation and a structure for each considered route, which in turn includes calculated parameters for the route and an image of the contact graph.

The [*dot*(1)](/dot/1.md) tool from the Graphviz package is used to generate the contact graph images and is required for [*cgrfetch*(1)](/cgrfetch/1.md). The [*base64*(1)](/base64/1.md) tool from coreutils is used to embed the images in the JSON and is also required.

## OPTIONS

- **DEST-NODE**

  The final destination to route to. To be useful, it should be a node that exists in the contact plan.

- **-q**

  Disable trace message output.

- **-j**

  Disable JSON output.

- **-m**

  Use a minimum-latency extended COS for the bundle. This ends up sending the bundle to all proximate nodes.

- **-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

- cgrfetch 8

  Simulate CGR with destination node 8 and dispatch time equal to the current time.

- cgrfetch 8 -t 60

  Do the same with a dispatch time 60 seconds in the future.

## SEE ALSO

[*dot*(1)](/dot/1.md), [*base64*(1)](/base64/1.md)