0chain / 0chain/zboxcli

[FEATURE] improve CLI command name and parameters with consistent naming

Open
#113 0 comments 0 reactions 1 assignee Claimed by @K-Kumar-01 View on GitHub
enhancement post-mainnet
Dominant language
Go
Stars
28
Forks
23
PR merge metrics
No merged PRs in 30d

Description

for now, there are some naming rules on cli command name
- lower-case: ` list-all`, `add-collab`
- lowercase: `listallocations`, `addcurator`,`encryptionpublickey`
- prefix: `alloc-cancel`,`alloc-fini`
- without prefix: `get`
- fullname: `list-all`
- shortname: `ls-blobbers`

And there are some naming rules on cli command parameters
- lower-case : `rx_pay`,`free_storage`,`read_price`, `write_price`
- lowercase: `remotepath`
- fullname: `allocation`
- shorname: `collabid`,`mcct`

It is better to rename all of them with consistent naming rule.

eg `lower-case with prefix and short name`, only root file system commands should be named without prefix.

for examples:
- `mkdir`, `copy`, `upload`, `download`,`delete`...etc
- `alloc-new`, `alloc-get`, `alloc-update`

see detail on https://0chain.slack.com/archives/C01U94VF56Y/p1632609085125300

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue is about renaming CLI commands and parameters for consistency. Start by examining the existing command definitions in the codebase, likely in files like cmd/ or main.go. Understand the current naming patterns and the proposed rules from the Slack link. Check for any tests that might need updating. 'Done' means all commands and their parameters follow a single, consistent naming convention.

Written by the indexing model from the issue text.

Assessment

Tech stack
cli, go, shell
Domain
cli, developer-experience
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.