Jira (BOLT-1342) Help text should only list options for that command

Lucy Wyman (JIRA)

unread,

May 24, 2019, 10:55:02 AM5/24/19

to puppe...@googlegroups.com

Lucy Wyman created an issue

Puppet Task Runner /

BOLT-1342

Help text should only list options for that command

Issue Type:	Task
Assignee:	Unassigned
Created:	2019/05/24 7:54 AM
Priority:	Normal
Reporter:	Lucy Wyman

Our help text currently lists all available options, even they aren't respected by the command. For example bolt puppetfile install -help lists -private-key, but doesn't actually use that private key for r10k configuration. We should add documentation around which arguments are respected by which commands, and update help text to only print the options for that specific command.

Add Comment

This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)

Lucy Wyman (JIRA)

unread,

May 28, 2019, 12:40:03 PM5/28/19

to puppe...@googlegroups.com

Lucy Wyman updated an issue

Puppet Task Runner /

BOLT-1342

Help text should only list options for that command

Change By:	Lucy Wyman

Our help text currently lists all available options, even they aren't respected by the command. For example {{bolt puppetfile install --help}} lists {{--private-key}}, but doesn't actually use that private key for r10k configuration. We should add documentation around which arguments are respected by which commands, and update help text to only print the options for that specific command.

Potentially look into using cri, though it might just be easier to write our own bespoke printing.
We should define which options are available for which subcommands - add one more level to the COMMANDS structure.