Skip to content

📖 Scribe: Document meshguard connect CLI command #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
igorls wants to merge 1 commit into from
Closed

📖 Scribe: Document meshguard connect CLI command #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,30 @@ meshguard trust <key-or-path> [--name <name>]

---

## `meshguard connect`

Direct peer connection via token exchange (no seed needed).

```bash
meshguard connect --generate [--in <minutes>]
meshguard connect --join <mg://token>
```

| Flag | Description |
| ------------ | ----------------------------------------------- |
| `--generate` | Initiator flag, generates an `mg://` token |
| `--join` | Joiner flag, accepts an `mg://` token |
| `--in` | Punch delay in minutes (default: 1 minute) |

**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)

---

## `meshguard revoke`

Remove a peer from your authorized keys.
Expand Down