ipfs/kubo

Rename "ipfs swarm peers" to "ipfs swarm conns"

Open

#4196 opened on Sep 1, 2017

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wantedkind/enhancement

Description

Type:

Enhancement(ish)

Severity:

Pedantic

Description:

ipfs swarm peers is misnamed, it should be ipfs swarm conns (it prints connections). We should:

  1. Introduce the new command.
  2. Deprecate the old one and hide it (but don't actually remove it).

Supersedes #4104 (would break too much)

Contributor guide

Tech stack
go
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingIPFS CLI basicsCommand deprecation patterns
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requires adding a new command 'ipfs swarm conns' that aliases the existing 'ipfs swarm peers' command, then deprecating and hiding the old command. The repository uses Go and the CLI is built with cobra. Look at the existing 'ipfs swarm peers' implementation (likely in core/commands/swarm.go) to understand the structure. The new command should call the same handler. Follow the deprecation pattern used elsewhere in the codebase, e.g., marking the old command as hidden and adding a deprecation message. No linked PRs or comments indicate prior work, so this is fresh territory.