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

Improve the CLI help #3996

Merged
merged 3 commits into from Oct 10, 2018
Merged

Improve the CLI help #3996

merged 3 commits into from Oct 10, 2018

Conversation

dduportal
Copy link
Contributor

What does this PR do?

This PR introduces the following changes:

  • For end-users: It improves the clarity of the traefik --help command line (CLI) output
  • For maintainers and contributors: Update of the dependency Flaeg to the version 1.3.0
  • For maintainers and contributors: It allows the commands make dep-ensure and make dep-prune to be run on macOS and BSD

Motivation

The current state of the traefik --help is very confusing: if you are getting started, you don't know where to put commands: before, after flags?

When updating dependencies on my mac, I also was facing an error message when running make dep-ensure. it was a simple fix so it has been smoothly added into the scope of this PR.

More

  • [-] Added/updated tests
  • [-] Added/updated documentation

Additional Notes

Example of the new output:

$ ./traefik --help
traefik is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease.
Complete documentation is available at https://traefik.io

Usage: traefik [flags] <command> [<arguments>]

Use "traefik <command> --help" for help on any command.

Commands:
        bug                                                Report an issue on Traefik bugtracker
        healthcheck                                        Calls traefik /ping to check health (web provider must be enabled)
        storeconfig                                        Store the static traefik configuration into a Key-value stores. Traefik will not start.
        version                                            Print version

Flag's usage: traefik [--flag=flag_argument] [-f[flag_argument]] ...     set flag_argument to flag(s)
          or: traefik [--flag[=true|false| ]] [-f[true|false| ]] ...     set true/false to boolean flag(s)

Flags:
...

Copy link
Contributor

@nmengin nmengin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dduportal dduportal requested a review from a team as a code owner October 10, 2018 15:44
@ldez ldez removed the request for review from a team October 10, 2018 15:44
@dduportal dduportal changed the base branch from master to v1.7 October 10, 2018 15:44
@ldez ldez added bot/light-review decreases the number of required LGTM from 3 to 1. and removed bot/no-merge labels Oct 10, 2018
Copy link
Member

@ldez ldez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>
Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>
Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>
@traefiker traefiker merged commit e8e9dd9 into traefik:v1.7 Oct 10, 2018
@traefiker traefiker removed bot/light-review decreases the number of required LGTM from 3 to 1. status/3-needs-merge labels Oct 10, 2018
@ldez ldez changed the title Improve the CLI help (Update of the Flaeg dependency) Improve the CLI help Oct 14, 2018
@dduportal dduportal deleted the enhancement/cli-update branch February 18, 2019 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement a new or improved feature. size/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants