ipfs/kubo

--read-timeout option for `ipfs get`

Open

#5,541 opened on Sep 28, 2018

View on GitHubContributor guide
 (15 comments) (6 reactions) (0 assignees)Go (2,725 forks)batch import
exp/novicehelp wantedkind/enhancement

Repository metrics

Stars
 (13,906 stars)
PR merge metrics
 (PR metrics pending)

Description

It would be useful for ipfs get (and possibly other related commands like ipfs cat) to have a --read-timeout option which would interrupt the command if no new data was read for a set amount of time.

Mentioned in https://github.com/ipfs/go-ipfs/issues/5537#issuecomment-425478248

Contributor guide

Research direction
Examine the command structure for 'ipfs get' and 'ipfs cat', identify where to add the read timeout flag, and implement the timeout logic using context or timers.
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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoGitIPFS basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60