lablup/raftify

Support machine-parsable output format in `describe` CLI command

Open

#169 opened on Oct 15, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (14 forks)auto 404
clifeaturegood first issue

Repository metrics

Stars
 (45 stars)
PR merge metrics
 (PR metrics pending)

Description

For the describe logs and describe metadata commands, currently only support output in raw format and table form. Let's add machine-parsable output format (such as JSON) flag in these commands.

Contributor guide

Research direction
Examine the current CLI argument parsing in the Rust codebase, locate where `describe logs` and `describe metadata` commands are implemented, and identify the output formatting logic. Then add a ` json` flag to output JSON instead of raw/table format.
Tech stack
rust
Domain
cli
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75