Skip to content

Update readme to match recent output format changes - #12

Open
varenc wants to merge 2 commits into
jaxxstorm:mainfrom
varenc:update-readme-output-format
Open

Update readme to match recent output format changes#12
varenc wants to merge 2 commits into
jaxxstorm:mainfrom
varenc:update-readme-output-format

Conversation

@varenc

@varenc varenc commented Jul 14, 2026

Copy link
Copy Markdown

The example output was from an older version. This updates it to match current behavior. Also make some minor corrections to the flag descriptions.

(LLM assisted)

varenc added 2 commits July 14, 2026 16:50
The example output was from an older version. This updates it to match current behavior.
Also make some minor corrections to the flag descriptions.

LLM assisted
@varenc

varenc commented Jul 14, 2026

Copy link
Copy Markdown
Author

and by 'recent changes', I mean changes from a year ago. I just upgraded to 0.0.12 from 0.0.8 and noticed this

Comment thread README.md
- **`--debug`**: Enable debug logging, showing STUN transactions and responses.
- **`--software <name>`**: Customize the SOFTWARE attribute in your STUN Binding Request (defaults to `tailnode`).
- **`--derpmapurl <URL>`**: Where to fetch the DERP map JSON if no STUN servers are specified (defaults to `https://login.tailscale.com/derpmap/default`).
- **`--derp-map-url <URL>`**: Where to fetch the DERP map JSON if no STUN servers are specified (defaults to `https://login.tailscale.com/derpmap/default`).

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix typo on this flag name, and document the new --no-ip flag

Comment thread README.md
```bash
Usage: stunner [flags]

A CLI tool to check your NAT Type

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this all is just a direct copy of stunner -h

Comment thread README.md
│ │
│ Server: derp25d.tailscale.com:3478 │
│ Port: 29752 │
│ IP Address: <omitted> │

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i figured explicitly omitting my IP is less confusing than copying the --no-ip output. Or could just use some other non-personal example IP

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant