ipfs/kubo

ipfs get and ipfs cat progress information

Open

#6083 opened on Mar 15, 2019

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

Description

Version information:

All versions

Type:

  • "feature": Json output of progress information for the commands ipfs get / ipfs cat

Description:

Would be nice when progress information which are reported by the commands ipfs get and ipfs cat are also be encoded in json (like other commands ipfs pubsub sub "--enc:json". Background: Then it is easier to parse the progress. Now it is almost impossible.

Contributor guide

Tech stack
go
Domain
clideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
mostly clear
Prerequisites
Go programming knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate how other commands like `ipfs pubsub sub` implement JSON encoding via ` enc:json` flag. The progress output for `ipfs get` and `ipfs cat` is likely emitted in `core/commands/get.go` and `core/commands/cat.go`. Look for progress reporting functions (e.g., `ProgressBar`) and modify them to output JSON when encoding is set. See https://github.com/ipfs/kubo/blob/master/core/commands/root.go for encoding handling.