Fixing "juju help commands"

[Marco Ceppi]

On Tue, May 24, 2016, 12:19 AM Tim Penhey <tim.penhey at canonical.com> wrote:

> Hi folks,
>
> More from the "let's fix the output" school of thought.
>
> One thing that has bugged me about 'juju help commands' was the repeated
> mentions of "alias for <blah>".
>
> I propose that we don't show aliases by default, and allow the user to
> task for them.
>
> Also, the supercommand describe commands method was written before I
> knew about the tabular output, so some code could be cleaned up there.
>
> Proposal:
>
> juju help commands
>    - shows the commands that are neither aliases, nor hidden
> juju help commands --alias
>    - shows either just the aliases, or everything including aliases
> juju help commands --all
>    - shows basic commands, aliases and hidden commands.
>
> I'd like to add the ability to say a command is hidden so it doesn't
> show up in the commands list. The purpose for these could be debugging
> assisting type functions, like "dump-model" or "debug-controller" (two
> commands that don't yet exist).
>

I don't see a need for this, I and other users often use juju help commands
to find or remind me of these commands. If you expect users to run these
debug/dump commands ever, show them.

Even if you don't expect people to run them, hidding them seems awkward.
Better to simply educate with good help output about what the command does
and when/why use the command.


> Thoughts?
>
> Tim
>
> --
> Juju-dev mailing list
> Juju-dev at lists.ubuntu.com
> Modify settings or unsubscribe at:
> https://lists.ubuntu.com/mailman/listinfo/juju-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/juju-dev/attachments/20160524/5706b162/attachment.html>