📖 Scribe: Document meshguard connect CLI command#62
Conversation
The `meshguard connect` command enables direct peer connection via token exchange (bypassing seed nodes) and performs a coordinated UDP hole punch. This command is implemented in `src/main.zig` but was missing from the CLI reference documentation. This commit adds the missing `meshguard connect` command documentation to `docs/reference/cli.md` to truthfully reflect the codebase implementation. Co-authored-by: igorls <4753812+igorls@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
There was a problem hiding this comment.
Pull request overview
Adds missing CLI reference documentation for meshguard connect, aligning the docs with the command’s built-in help/usage in src/main.zig.
Changes:
- Documented
meshguard connectpurpose and basic usage (--generate/--join). - Added flag reference for
--generate,--join, and--in. - Described the token-exchange flow for coordinated punching.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Closing: superseded by docs audit fixes and direct commits to main. See PR #67 (merged) for codec bounds check, and direct commit for timing-safe fix in noise.zig. |
Understood. Acknowledging that this work is now obsolete and stopping work on this task. |
💡 What: Added missing documentation for
meshguard connectcommand todocs/reference/cli.md.🔍 Source:
src/main.zig📝 Fix: Documented the
connectcommand, its flags (--generate,--join,--in), and the connection flow.PR created automatically by Jules for task 3006533866175062450 started by @igorls