iroh-doctor

Test your network.

Docs Site | Rust Docs | Releases

Overview

iroh-doctor is a tool used for diagnosing network issues with iroh.

Getting Started

Run cargo install iroh-doctor or build from source.

Usage: iroh-doctor [OPTIONS] <COMMAND>

Commands:
  report          Report on the current network environment, using either an explicitly provided stun host or the settings from the config file
  accept          Wait for incoming requests from iroh doctor connect
  connect         Connect to an iroh doctor accept node
  port-map-probe  Probe the port mapping protocols
  port-map        Attempt to get a port mapping to the given local port
  relay-urls      Get the latencies of the different relay url
  plot            Plot metric counters
  help            Print this message or the help of the given subcommand(s)

Options:
      --config <CONFIG>
          Path to the configuration file, see https://iroh.computer/docs/reference/config

      --metrics-addr <METRICS_ADDR>
          Address to serve metrics on. Disabled by default

      --metrics-dump-path <METRICS_DUMP_PATH>
          Write metrics in CSV format at 100ms intervals. Disabled by default

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

License

Copyright 2024 N0, INC.

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.