https://github.com/n0-computer/iroh-doctor

Your tool for testing iroh connectivity
https://github.com/n0-computer/iroh-doctor

Last synced: 4 months ago
JSON representation

Your tool for testing iroh connectivity

• Host: GitHub
• URL: https://github.com/n0-computer/iroh-doctor
• Owner: n0-computer
• License: apache-2.0
• Created: 2024-10-21T15:49:09.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-05-15T08:37:46.000Z (about 1 year ago)
• Last Synced: 2025-05-15T09:31:02.348Z (about 1 year ago)
• Language: Rust
• Homepage:
• Size: 1.93 MB
• Stars: 8
• Watchers: 6
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-APACHE
  • Code of conduct: code_of_conduct.md

Awesome Lists containing this project

README

          
iroh-doctor




Test your network.



[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square)](https://docs.rs/iroh-doctor/)

[![Crates.io](https://img.shields.io/crates/v/iroh.svg?style=flat-square)](https://crates.io/crates/iroh-doctor)

[![downloads](https://img.shields.io/crates/d/iroh.svg?style=flat-square)](https://crates.io/crates/iroh-doctor)

[![Chat](https://img.shields.io/discord/1161119546170687619?logo=discord&style=flat-square)](https://discord.com/invite/DpmJgtU7cW)

[![Youtube](https://img.shields.io/badge/YouTube-red?logo=youtube&logoColor=white&style=flat-square)](https://www.youtube.com/@n0computer)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](LICENSE-MIT)

[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square)](LICENSE-APACHE)



  


    

      Docs Site

    

     | 

    

      Rust Docs

    

     | 

    

      Releases

    

  






## Overview

iroh-doctor is a tool used for diagnosing network issues with [iroh](https://github.com/n0-computer/iroh).

## Getting Started

Run `cargo install iroh-doctor` or build from source.

```shell

Usage: iroh-doctor [OPTIONS] 

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 

          Path to the configuration file, see https://iroh.computer/docs/reference/config

      --metrics-addr 

          Address to serve metrics on. Disabled by default

      --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](LICENSE-APACHE) or

   http://www.apache.org/licenses/LICENSE-2.0)

 * MIT license ([LICENSE-MIT](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.