From 9587dbce8c122e61f6cae4b208a8819bd71ced40 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9Cramfox=E2=80=9D?= <“kasey@n0.computer”>
Date: Tue, 14 Jan 2025 15:19:48 -0500
Subject: [PATCH 1/5] chore: Release iroh-doctor version 0.31.0
---
Cargo.lock | 2 +-
Cargo.toml | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
index 34e3ef9..be95135 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -1970,7 +1970,7 @@ dependencies = [
[[package]]
name = "iroh-doctor"
-version = "0.1.0"
+version = "0.31.0"
dependencies = [
"anyhow",
"async-channel",
diff --git a/Cargo.toml b/Cargo.toml
index ab81171..2eb020c 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "iroh-doctor"
-version = "0.1.0"
+version = "0.31.0"
edition = "2021"
readme = "README.md"
description = "Diagnose and test iroh in your network configuration"
From 02df7599645eac3660a593ec752cd5d9cf080b15 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9Cramfox=E2=80=9D?= <“kasey@n0.computer”>
Date: Wed, 15 Jan 2025 13:55:33 -0500
Subject: [PATCH 2/5] docs: clean up readme
---
README.md | 53 ++++++++++++++++++++++++++++++-----------------------
1 file changed, 30 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index 710628c..48bc160 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,16 @@
-
+
-A toolkit for building distributed applications
+Test your network.
-[](https://docs.rs/iroh/)
-[](https://crates.io/crates/iroh)
-[](https://crates.io/crates/iroh)
+[](https://docs.rs/iroh-doctor/)
+[](https://crates.io/crates/iroh-doctor)
+[](https://crates.io/crates/iroh-doctor)
[](https://discord.com/invite/DpmJgtU7cW)
[](https://www.youtube.com/@n0computer)
[](LICENSE-MIT)
[](LICENSE-APACHE)
-[](https://github.com/n0-computer/iroh/actions/workflows/ci.yml)
@@ -30,35 +29,43 @@ A toolkit for building distributed applications
-## Features
-
-- Documents - Authors create and join documents: mutable key-value stores that multiple users read from, write to, and sync with, subscribing to live updates in real time.
-- Blobs - Iroh works with content-addressed blobs of opaque data, which are often the bytes of a file.
-- Networking - At the core of iroh is the ability to connect any two devices, no matter where they are.
-
## Overview
-Iroh is a protocol for syncing & moving bytes. Bytes of any size, on any device. At its core, it's a peer-2-peer network built on a _magic socket_ that establishes [QUIC](https://en.wikipedia.org/wiki/QUIC) connections between peers. Peers request and provide _blobs_ of opaque bytes that are incrementally verified by their BLAKE3 hash during transfer.
+iroh-doctor is a tool used for diagnosing network issues with [iroh](https://github.com/n0-computer/iroh).
## Getting Started
-Iroh is delivered as a Rust library and a CLI.
-
-### Library
+Run `cargo install iroh-doctor` or build from source.
-Run `cargo add iroh`, to add `iroh` to your project.
+```shell
+Usage: iroh-doctor [OPTIONS]
-### CLI
+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)
-Check out https://iroh.computer/docs/install to get started.
+Options:
+ --config
+ Path to the configuration file, see https://iroh.computer/docs/reference/config
-The implementation lives in the `iroh-cli` crate.
+ --metrics-addr
+ Address to serve metrics on. Disabled by default
-### Links
+ --metrics-dump-path
+ Write metrics in CSV format at 100ms intervals. Disabled by default
-- [Introducing Iroh (video)](https://www.youtube.com/watch?v=RwAt36Xe3UI_)
-- [Iroh Examples](https://github.com/n0-computer/iroh-examples)
+ -h, --help
+ Print help (see a summary with '-h')
+ -V, --version
+ Print version
+```
## License
From 5398d21e0debacee2c8e16be7a973dcdc4602b17 Mon Sep 17 00:00:00 2001
From: Kasey
Date: Thu, 16 Jan 2025 13:44:33 -0500
Subject: [PATCH 3/5] Update README.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Philipp Krüger
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 48bc160..419ff5a 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-
+
Test your network.
From 6eb8d400c0c61fadbea5e7bcca949dda86be1dae Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9Cramfox=E2=80=9D?= <“kasey@n0.computer”>
Date: Thu, 16 Jan 2025 13:47:49 -0500
Subject: [PATCH 4/5] remove "iroh" image for "iroh-doctor" text
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 419ff5a..2c06004 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-
+
Test your network.
From 96656b43bfe55bbfb9ada0444051537554bc9685 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9Cramfox=E2=80=9D?= <“kasey@n0.computer”>
Date: Thu, 16 Jan 2025 13:57:01 -0500
Subject: [PATCH 5/5] color the "iroh-doctor" link
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 2c06004..d5bb349 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-
+
Test your network.