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

Help doesn't show all possible arguments #1036

Closed
de-sh opened this issue Dec 16, 2024 · 3 comments · Fixed by #1053
Closed

Help doesn't show all possible arguments #1036

de-sh opened this issue Dec 16, 2024 · 3 comments · Fixed by #1053
Assignees
Labels
enhancement New feature or request

Comments

@de-sh
Copy link
Contributor

de-sh commented Dec 16, 2024

The binary can take a lot of arguments/env variables, but currently, the following is the output of the call to parseable --help

Parseable v1.6.3

Cloud Native, log analytics platform for modern applications.
Join the community at https://logg.ing/community.

Commands:
  local-store  Start Parseable with a drive as storage
  s3-store     Start Parseable with S3 or compatible as storage
  blob-store   Start Parseable with Azure Blob storage
  help         Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

No listing of possible commandline arguments is shown as would be expected from a commandline utility.

@TwistingTwists
Copy link
Contributor

Please assign this to me. :)

@nitisht nitisht added the enhancement New feature or request label Dec 25, 2024
@TwistingTwists
Copy link
Contributor

https://asciinema.org/a/dvfmqCQzG1HqzeX5uRRYgFaRG

the cli follow standard clap behaviour. of showing commands and nested commands, one level at a time.

@de-sh
Copy link
Contributor Author

de-sh commented Dec 25, 2024

@TwistingTwists the main idea behind this PR was to point out the available options at the global level, the idea is that we should print the common options for all subcommands, stuff like setting up kafka connector, hottier etc. But now that I think about it from a user perspective the following addition could be good enough to point the usage of each command:

parseable [command] [options..]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants