Repository navigation
[RFC] plugins should support a --help flag #1682
Description
One thing I just noticed;
Usage: docker [OPTIONS] COMMAND
A self-sufficient runtime for containers
...
Commands:
...
commit Create a new image from a container's changes
compose (Docker) Define and run multi-container applications
Run 'docker COMMAND --help' for more information on a command.
The help / usage output states that a COMMAND should handle a --help flag, so should we define that a plugin should support that flag (at least at their top-level command) as part of the "api"?
Activity
thaJeztah commentedon Feb 21, 2019
/cc @ijc @silvin-lubecki @chris-crone
ijc commentedon Feb 21, 2019
At the CLI level running
docker «plugin» --helpalready DTRT and calls--helpon the plugin, it's up to the plugin what to do with it, the builtin framework/helper implements it too.We can certainly recommend they implement
--help(and similarlyhelp «command») but I think this is just a docs change, no code change needed.thaJeztah commentedon Feb 21, 2019
Yes, no code change is needed, but we should have it defined (or at least mentioned) as part of the "contract" for plugins.