Feature #4503: nfdc: add aliases of ‘help’ subcommand - NFD - NDN project issue tracking system

Feature #4503

closed

nfdc: add aliases of ‘help’ subcommand

Added by Alex Afanasyev about 6 years ago. Updated about 6 years ago.

Status:

Closed

Priority:

Normal

Assignee:

Davide Pesavento

Category:

Tools

Target version:

v0.7

Start date:

Due date:

% Done:

100%

Estimated time:

Description

‘nfdc help face’ should be aliased as:

nfdc face -h
nfdc face help

Related issues 1 (1 open — 0 closed)

Related to NFD - Feature #4505: nfdc: TAB completion for command names

New

02/15/2018

Actions

Issue # Delay: days Cancel

History
Notes
Property changes

Actions

Copy link

Updated by Junxiao Shi about 6 years ago

Try nfdc help face.

Actions

Copy link

Updated by Alex Afanasyev about 6 years ago

Please make aliases to this one. Not receiving any hint is really frustrating.

Actions

Copy link

Updated by Nicholas Gordon about 6 years ago

I agree. Most people building it from source won't install the manpages, either. I don't even know how to install them, for example.

Actions

Copy link

Updated by Davide Pesavento about 6 years ago

Subject changed from Improve usability of `nfdc` to Improve usability of nfdc
Category set to Tools

100% agree. I've been wanting to open a similar issue for a long time. Current nfdc is very unfriendly to the user.

Actions

Copy link

Updated by Junxiao Shi about 6 years ago

Tracker changed from Task to Feature
Subject changed from Improve usability of nfdc to nfdc: add aliases of ‘help’ subcommand
Description updated (diff)

Original description:

I am having really hard time with nfdc interface, as it does not provide help along the way. Here are my expectation to give me hints (to give short list of available commands) nfdc face nfdc face -h nfdc face help

An issue must have measurable completion point, and “improving useability” is a goal but does not have measurable completion.
I’ve limited the scope of this issue to provide aliases only. Note that ‘nfdc face’ cannot be aliased to ‘nfdc help face’ because it’s already an alias of ‘nfdc face list’.
A follow-up issue #4505 offers TAB completion of command names, further improves useability.

Actions

Copy link

Updated by Junxiao Shi about 6 years ago

Related to Feature #4505: nfdc: TAB completion for command names added

Actions

Copy link

Updated by Davide Pesavento about 6 years ago

Status changed from New to In Progress
Assignee set to Davide Pesavento
Target version set to v0.7

Actions

Copy link

Updated by Davide Pesavento about 6 years ago

Status changed from In Progress to Code review
% Done changed from 0 to 100

https://gerrit.named-data.net/4545

Actions

Copy link

Updated by Junxiao Shi about 6 years ago

hmm do we want this to work also for nfdc <module> <verb> --help? i.e. when both module and verb are specified before --help? (it doesn't at the moment)

Yes, nfdc noun verb —help and nfdc noun verb -h are useful.
nfdc noun verb help should be avoided because it causes ambiguity with a command argument named “help”.

Actions

Copy link

#10

Updated by Davide Pesavento about 6 years ago

Junxiao Shi wrote:

nfdc noun verb help should be avoided because it causes ambiguity with a command argument named “help”.

No command has an argument named "help" at the moment, and I don't expect we'll ever have one. It's more important to reserve "help" as a synonym of "--help".

Actions

Copy link

#11