Skip to content

Commit

Permalink
docs(commands): explain that swarm connect can reuse existing connect…
Browse files Browse the repository at this point in the history
…ions or known addresses (#10015)
  • Loading branch information
aschmahmann authored Jul 20, 2023
1 parent 4a5e99d commit 1fe17a4
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions core/commands/swarm.go
Original file line number Diff line number Diff line change
Expand Up @@ -650,11 +650,13 @@ var swarmAddrsListenCmd = &cmds.Command{

var swarmConnectCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Open connection to a given address.",
Tagline: "Open connection to a given peer.",
ShortDescription: `
'ipfs swarm connect' opens a new direct connection to a peer address.
'ipfs swarm connect' attempts to ensure a connection to a given peer.
The address format is an IPFS multiaddr:
Multiaddresses given are advisory, for example the node may already be aware of other addresses for a given peer or may already have an established connection to the peer.
The address format is a libp2p multiaddr:
ipfs swarm connect /ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
`,
Expand Down

0 comments on commit 1fe17a4

Please sign in to comment.