Expand README with worked examples for every command - #16
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4a1adecbe6
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ```bash | ||
| netprobe http example.com | ||
| netprobe http example.com -L # walk every redirect hop |
There was a problem hiding this comment.
For redirect chains longer than ten hops, follow() stops when len(hops) == max_hops (default 10), so -L does not walk every redirect hop or show the terminal response. This comment overpromises the behavior precisely for long or looping chains where complete redirect diagnostics matter; describe the ten-hop limit instead.
Useful? React with 👍 / 👎.
| python -m ruff check . | ||
| ``` | ||
|
|
||
| 84 tests, no test dependencies to install. See [CONTRIBUTING.md](CONTRIBUTING.md). |
There was a problem hiding this comment.
The reviewed commit contains no CONTRIBUTING.md anywhere in its repository tree, so this development link is guaranteed to lead readers to a 404. Add the referenced guide or remove the link.
Useful? React with 👍 / 👎.
1 participant
The README was a stub from the scaffolding PR and never caught up with the six commands that landed after it.
Now documents each command with real console output rather than just a flag list, plus the parts that are not guessable from
--help:0success,1check failed,2usage,130interrupted. This is the contract that makesnetprobe subnet 10.0.0.0/8 --contains X && ...and monitoring checks work, and it was undocumented[0]for a scalar/31and/32handling, and whylatencyuses TCP rather than ICMPAdds CI, Python version and license badges.