Closed
Description
When running gitlab --help
to get the list of objects that can be modified the output is unformatted JSON. I'd suggest formatting it as a list like below for easier human reading:
Current output:
usage: gitlab [-h] [--version] [-v] [-d] [-c CONFIG_FILE] [-g GITLAB]
[-o {json,legacy,yaml}] [-f FIELDS]
{application-settings,broadcast-message,current-user,current-user-email,current-user-gp-gkey,current-user-key,deploy-key,dockerfile,event,feature,gitignore,gitlabciyml,group,group-access-request,group-custom-attribute,group-issue,group-member,group-milestone,group-notification-settings,group-project,group-subgroup,group-variable,hook,issue,license,namespace,notification-settings,pages-domain,project,project-access-request,project-board,project-board-list,project-branch,project-commit,project-commit-comment,project-commit-status,project-custom-attribute,project-deployment,project-environment,project-event,project-file,project-fork,project-hook,project-issue,project-issue-award-emoji,project-issue-note,project-issue-note-award-emoji,project-job,project-key,project-label,project-member,project-merge-request,project-merge-request-award-emoji,project-merge-request-diff,project-merge-request-note,project-merge-request-note-award-emoji,project-milestone,project-note,project-notification-settings,project-pages-domain,project-pipeline,project-pipeline-job,project-pipeline-schedule,project-pipeline-schedule-variable,project-protected-branch,project-runner,project-service,project-snippet,project-snippet-award-emoji,project-snippet-note,project-snippet-note-award-emoji,project-tag,project-trigger,project-user,project-variable,project-wiki,runner,snippet,todo,user,user-activities,user-custom-attribute,user-email,user-event,user-gp-gkey,user-impersonation-token,user-key,user-project}
Suggested output:
usage: gitlab [-h] [--version] [-v] [-d] [-c CONFIG_FILE] [-g GITLAB]
[-o {json,legacy,yaml}] [-f FIELDS] <OBJECT> <ACTION>
Where OBJECT is one of:
application-settings
broadcast-message
current-user
current-user-email
current-user-gp-gkey
current-user-key
deploy-key
dockerfile
event
feature
gitignore
gitlabciyml
group
group-access-request
group-custom-attribute
group-issue
group-member
group-milestone
group-notification-settings
group-project
group-subgroup
group-variable
hook
issue
license
namespace
notification-settings
pages-domain
project
project-access-request
project-board
project-board-list
project-branch
project-commit
project-commit-comment
project-commit-status
project-custom-attribute
project-deployment
project-environment
project-event
project-file
project-fork
project-hook
project-issue
project-issue-award-emoji
project-issue-note
project-issue-note-award-emoji
project-job
project-key
project-label
project-member
project-merge-request
project-merge-request-award-emoji
project-merge-request-diff
project-merge-request-note
project-merge-request-note-award-emoji
project-milestone
project-note
project-notification-settings
project-pages-domain
project-pipeline
project-pipeline-job
project-pipeline-schedule
project-pipeline-schedule-variable
project-protected-branch
project-runner
project-service
project-snippet
project-snippet-award-emoji
project-snippet-note
project-snippet-note-award-emoji
project-tag
project-trigger
project-user
project-variable
project-wiki
runner
snippet
todo
user
user-activities
user-custom-attribute
user-email
user-event
user-gp-gkey
user-impersonation-token
user-key
user-project