Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Improve command line description and flag naming and description

See original GitHub issue

Description

The core CLI commands description and flag description of grammar needs to be corrected.

Motivation

The core CLI commands will be interfaced with developers and users, for better understanding of commands the grammar needs to be corrected.

Revisit all the core CLI commands and fix the grammar.

Acceptance Criteria

Update Root and sub root commands description with better grammar
Update flags and its description with better grammar

Additional Information

Example Actual

blockchain:download  Download blockchain data from a provided snapshot.
blockchain:export    Export blockchain data for given data path
blockchain:hash      Generate hash for blockchain data for given data path
blockchain:import    Import blockchain data for given data path
blockchain:reset     Resets the blockchain data.

Improved version

blockchain:download  Download from <URL>.
blockchain:export    Export to <FILE>
blockchain:import    Import from <FILE>

Issue Analytics

State:
Created 3 years ago
Comments:6 (6 by maintainers)

Top GitHub Comments

1reaction

ManuGowdacommented, Sep 16, 2020

Comments from @Incede:

account:create command

1. After taking the passphrase input the cursor has a wrong position
2. --help description can be better

block:get Wrong error message when block height does not exist

blockchain:export Wrong error message when output/input directory not found

1reaction

pablitovicentecommented, Sep 9, 2020

--enable-forger which is for enabling the forger plugin should be renamed as it could be confused as a flag for enabling forging

Top Results From Across the Web

Command Line Interface Guidelines

An open-source guide to help you write better command-line programs, taking traditional UNIX ... Descriptions of flags, unless there are lots of them....

Command-line Flags (by Category) - cSounds.com

You can view the command line flags organized alphabetically in Command-line Flags ... Certain flag arguments take a following name or numeric argument....

Command-line syntax overview for System.CommandLine

An introduction to the command-line syntax that the System. ... a brief description of the available commands, options, and arguments.

Command line options - AWS Documentation

In the AWS CLI, command line options are global parameters you can use to override the default configuration settings, any corresponding profile setting, ......

How To Use the Flag Package in Go - DigitalOcean

Go lets you craft command-line utilities that accept flags by using ... Int counterpart: the flag name, a default value, and a description....