gitlab icon indicating copy to clipboard operation
gitlab copied to clipboard

Published 20 hours ago • verified publisher icon NARKOZ

Command should print out usage information

Open wkoszek opened this issue 7 years ago • 5 comments

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.

wkoszek avatar Jan 07 '18 17:01 wkoszek

@wkoszek any example?

sotayamashita avatar Jan 26 '18 09:01 sotayamashita

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Aug 13 '18 01:08 stale[bot]

@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

NARKOZ avatar Oct 15 '18 11:10 NARKOZ

@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!

wkoszek avatar Oct 15 '18 17:10 wkoszek

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)

perlun avatar May 31 '22 11:05 perlun