Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFC] plugins should support a --help flag #1682

Open
thaJeztah opened this issue Feb 21, 2019 · 3 comments
Open

[RFC] plugins should support a --help flag #1682

thaJeztah opened this issue Feb 21, 2019 · 3 comments

Comments

@thaJeztah
Copy link
Member

relates to #1661 and #1534

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"?

@thaJeztah
Copy link
Member Author

/cc @ijc @silvin-lubecki @chris-crone

@ijc
Copy link
Contributor

ijc commented Feb 21, 2019

At the CLI level running docker «plugin» --help already DTRT and calls --help on 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 similarly help «command») but I think this is just a docs change, no code change needed.

@thaJeztah
Copy link
Member Author

Yes, no code change is needed, but we should have it defined (or at least mentioned) as part of the "contract" for plugins.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants