📖 Scribe: Document meshguard connect CLI command#60
Conversation
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 the existing meshguard connect command and records a process learning to help prevent future code/docs drift for manually parsed CLI commands.
Changes:
- Documented
meshguard connectusage and the token-exchange flow indocs/reference/cli.md. - Added a scribe entry capturing the documentation gap and a suggested prevention audit in
.jules/scribe.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/reference/cli.md | Adds a new meshguard connect section with synopsis + flow description. |
| .jules/scribe.md | Records the documentation gap/learning and a prevention checklist item. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| meshguard connect --generate [--in <minutes>] | ||
| meshguard connect --join <mg://token> | ||
| ``` |
There was a problem hiding this comment.
The implementation defaults to generate mode when no sub-flag is provided (mode starts as .generate). The docs currently imply --generate is required; consider documenting that meshguard connect alone is equivalent to meshguard connect --generate, or update the usage synopsis to reflect that --generate is optional/default.
| **Flow**: | ||
|
|
||
| 1. Initiator runs `--generate`, shares `mg://` token with peer | ||
| 2. Peer runs `--join <token>`, shares response token back | ||
| 3. Initiator pastes response token | ||
| 4. Both sides punch simultaneously (NTP-synced) | ||
|
|
There was a problem hiding this comment.
--in <minutes> is listed in the synopsis but its meaning and default value aren’t documented here (the CLI help says it’s a punch delay with a default of 1 minute). Adding a short options table or a one-liner describing --in (and its default) would prevent ambiguity.
|
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: The
meshguard connectcommand was implemented in the code (src/main.zig) but its CLI flag usage and command sequence was completely undocumented in the CLI reference.🔍 Source:
src/main.zig(where thestd.mem.eql(u8, command, "connect")block and its internal flags/help text reside).📝 Fix: Added the
meshguard connectsection todocs/reference/cli.mddetailing the flow (--generate,--join) and its optional flags (--in <minutes>). Appended a learning regarding manual CLI argument parsing to.jules/scribe.md.PR created automatically by Jules for task 11544638676060261202 started by @igorls