yugabyte/yugabyte-db

[usability] Allow prefix matching for yb-admin commands

Open

#9,624 opened on Aug 6, 2021

View on GitHub
 (4 comments) (0 reactions) (1 assignee)C (1,003 forks)batch import
area/docdbgood first issuehelp wantedkind/enhancementpriority/medium

Repository metrics

Stars
 (8,229 stars)
PR merge metrics
 (Avg merge 17d 21h) (92 merged PRs in 30d)

Description

Jira Link: DB-2024 Currently when yb-admin command is slightly misspelled, e.g. list_snapshot_schedule instead of list_snapshot_schedules, the user would be given the whole list of commands.

User experience can be improved by using the (partial) command as prefix.

If there is only one match, that match would be picked - we can ask the user to confirm the selection (or add option, say -accept-prefix-match which would accept the selection without asking). In case there are multiple candidates for the given prefix, the list of commands would be printed.

Contributor guide

Research direction
Examine the yb admin command parsing logic. Identify where commands are matched and implement prefix matching: if a partial command uniquely matches a full command, offer to execute it (with a confirmation option). If multiple matches, list them. Look for existing command registration structure.
Tech stack
cgo
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.
Half day
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
Gitcommand line basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60