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

Command should print out usage information #345

Open
wkoszek opened this issue Jan 7, 2018 · 5 comments
Open

Command should print out usage information #345

wkoszek opened this issue Jan 7, 2018 · 5 comments
Labels
enhancement New feature or request help wanted Good for newcomers

Comments

@wkoszek
Copy link

wkoszek commented Jan 7, 2018

I've installed a gitlab Gem, but the gitlab help isn't very helpful. I need to read a README.md from this repo to understand how to use it. I think gitlab help should print out a standard UNIX usage information with some examples.

@NARKOZ NARKOZ added help wanted Good for newcomers enhancement New feature or request labels Jan 7, 2018
@sotayamashita
Copy link
Collaborator

@wkoszek any example?

@stale

This comment has been minimized.

@stale stale bot added the stale Inactive label Aug 13, 2018
@NARKOZ NARKOZ removed the stale Inactive label Aug 13, 2018
@NARKOZ NARKOZ added the hacktoberfest-accepted Hacktoberfest event label Oct 1, 2018
@NARKOZ
Copy link
Owner

NARKOZ commented Oct 15, 2018

@wkoszek any example?

I think it should be like in man hub https://github.com/github/hub/blob/70a5493539d7a614449f0d32051e08b0dbc53bc3/share/man/man1/hub.1.ronn

@wkoszek
Copy link
Author

wkoszek commented Oct 15, 2018

@NARKOZ Right. Instead of just listing options, show 20 simple one-liners with explanations on what they do. hub, awk, jq and other commands will give you an idea. Thanks!

@NARKOZ NARKOZ removed hacktoberfest-accepted Hacktoberfest event labels Nov 2, 2018
@NARKOZ NARKOZ added the hacktoberfest-accepted Hacktoberfest event label Oct 9, 2019
@NARKOZ NARKOZ removed the hacktoberfest-accepted Hacktoberfest event label Nov 19, 2019
@NARKOZ NARKOZ added the hacktoberfest-accepted Hacktoberfest event label Oct 1, 2020
@NARKOZ NARKOZ removed the hacktoberfest-accepted Hacktoberfest event label Nov 11, 2020
@perlun
Copy link

perlun commented May 31, 2022

Adding to this, it's also unclear how to use the --only and --except flags. Example:

$ gitlab jobs 2 "{scope: ["success"], per_page: 100 }" --except artifacts 
wrong number of arguments (given 4, expected 1..2)
$ gitlab jobs 2 "{scope: ["success"], per_page: 100 }" --only artifacts
wrong number of arguments (given 4, expected 1..2)

(Using v4.18.0 of the gem)

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

No branches or pull requests

4 participants