Skip to content

Commit 7128f8b

Browse files
DannyBenDannyBen
authored
show shortcut in command usage (#42)
1 parent c4f614c commit 7128f8b

File tree

22 files changed

+108
-5
lines changed

22 files changed

+108
-5
lines changed

‎examples/colors/colorly‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ colorly_usage() {
2929
printf "colorly - Sample application that uses the color functions\n"
3030
echo
3131
fi
32+
3233
printf "Usage:\n"
3334
printf " colorly [MESSAGE] [options]\n"
3435
printf " colorly --help | -h\n"

‎examples/config-ini/configly‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ configly_usage() {
1616
printf "configly - Sample application that uses the config functions\n"
1717
echo
1818
fi
19+
1920
printf "Usage:\n"
2021
printf " configly [command] [options]\n"
2122
printf " configly [command] --help | -h\n"
@@ -50,6 +51,10 @@ configly_set_usage() {
5051
printf "configly set - Save a value in the config file\n"
5152
echo
5253
fi
54+
55+
printf "Shortcut: s\n"
56+
echo
57+
5358
printf "Usage:\n"
5459
printf " configly set KEY VALUE [options]\n"
5560
printf " configly set --help | -h\n"
@@ -93,6 +98,10 @@ configly_get_usage() {
9398
printf "configly get - Read a value from the config file\n"
9499
echo
95100
fi
101+
102+
printf "Shortcut: g\n"
103+
echo
104+
96105
printf "Usage:\n"
97106
printf " configly get KEY [options]\n"
98107
printf " configly get --help | -h\n"
@@ -131,6 +140,10 @@ configly_list_usage() {
131140
printf "configly list - Show the entire config file\n"
132141
echo
133142
fi
143+
144+
printf "Shortcut: l\n"
145+
echo
146+
134147
printf "Usage:\n"
135148
printf " configly list [options]\n"
136149
printf " configly list --help | -h\n"

‎examples/custom-includes/download‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ download_usage() {
2525
printf "download - Sample minimal application with custom strings\n"
2626
echo
2727
fi
28+
2829
printf "Usage:\n"
2930
printf " download [SOURCE] [options]\n"
3031
printf " download --help | -h\n"

‎examples/custom-strings/download‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ download_usage() {
2424
printf "download - Sample minimal application with custom strings\n"
2525
echo
2626
fi
27+
2728
printf "== Usage ==\n\n"
2829
printf " download SOURCE [options]\n"
2930
printf " download --help | -h\n"

‎examples/default-command/ftp‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ ftp_usage() {
1616
printf "ftp - Sample application that uses the default command option\n"
1717
echo
1818
fi
19+
1920
printf "Usage:\n"
2021
printf " ftp [command] [options]\n"
2122
printf " ftp [command] --help | -h\n"
@@ -49,6 +50,10 @@ ftp_upload_usage() {
4950
printf "ftp upload - Upload a file\n"
5051
echo
5152
fi
53+
54+
printf "Shortcut: u\n"
55+
echo
56+
5257
printf "Usage:\n"
5358
printf " ftp upload SOURCE [options]\n"
5459
printf " ftp upload --help | -h\n"
@@ -81,6 +86,10 @@ ftp_download_usage() {
8186
printf "ftp download - Download a file\n"
8287
echo
8388
fi
89+
90+
printf "Shortcut: d\n"
91+
echo
92+
8493
printf "Usage:\n"
8594
printf " ftp download SOURCE [options]\n"
8695
printf " ftp download --help | -h\n"

‎examples/dependencies/cli‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ cli_usage() {
1616
printf "cli - Sample application that requires dependencies\n"
1717
echo
1818
fi
19+
1920
printf "Usage:\n"
2021
printf " cli [command] [options]\n"
2122
printf " cli [command] --help | -h\n"
@@ -49,6 +50,7 @@ cli_download_usage() {
4950
printf "cli download - Download something\n"
5051
echo
5152
fi
53+
5254
printf "Usage:\n"
5355
printf " cli download [options]\n"
5456
printf " cli download --help | -h\n"
@@ -73,6 +75,7 @@ cli_upload_usage() {
7375
printf "cli upload - Upload something\n"
7476
echo
7577
fi
78+
7679
printf "Usage:\n"
7780
printf " cli upload [options]\n"
7881
printf " cli upload --help | -h\n"

‎examples/docker-like/docker‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ docker_usage() {
1616
printf "docker - Docker example\n"
1717
echo
1818
fi
19+
1920
printf "Usage:\n"
2021
printf " docker [command] [options]\n"
2122
printf " docker [command] --help | -h\n"
@@ -49,6 +50,10 @@ docker_container_usage() {
4950
printf "docker container - Container commands\n"
5051
echo
5152
fi
53+
54+
printf "Shortcut: c*\n"
55+
echo
56+
5257
printf "Usage:\n"
5358
printf " docker container [command] [options]\n"
5459
printf " docker container [command] --help | -h\n"
@@ -78,6 +83,7 @@ docker_container_run_usage() {
7883
printf "docker container run - Run a container\n"
7984
echo
8085
fi
86+
8187
printf "Usage:\n"
8288
printf " docker container run IMAGE [options]\n"
8389
printf " docker container run --help | -h\n"
@@ -110,6 +116,7 @@ docker_container_stop_usage() {
110116
printf "docker container stop - Stop a container\n"
111117
echo
112118
fi
119+
113120
printf "Usage:\n"
114121
printf " docker container stop CONTAINER [options]\n"
115122
printf " docker container stop --help | -h\n"
@@ -142,6 +149,10 @@ docker_image_usage() {
142149
printf "docker image - Image commands\n"
143150
echo
144151
fi
152+
153+
printf "Shortcut: i*\n"
154+
echo
155+
145156
printf "Usage:\n"
146157
printf " docker image [command] [options]\n"
147158
printf " docker image [command] --help | -h\n"
@@ -170,6 +181,10 @@ docker_image_ls_usage() {
170181
printf "docker image ls - Show all images\n"
171182
echo
172183
fi
184+
185+
printf "Shortcut: l\n"
186+
echo
187+
173188
printf "Usage:\n"
174189
printf " docker image ls [options]\n"
175190
printf " docker image ls --help | -h\n"

‎examples/environment-variables/cli‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ cli_usage() {
1616
printf "cli - Sample application that requires environment variables\n"
1717
echo
1818
fi
19+
1920
printf "Usage:\n"
2021
printf " cli [command] [options]\n"
2122
printf " cli [command] --help | -h\n"
@@ -56,6 +57,10 @@ cli_verify_usage() {
5657
printf "cli verify - Verify your user\n"
5758
echo
5859
fi
60+
61+
printf "Shortcut: v\n"
62+
echo
63+
5964
printf "Usage:\n"
6065
printf " cli verify [options]\n"
6166
printf " cli verify --help | -h\n"

‎examples/git-like/git‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ git_usage() {
1616
printf "git - Git example\n"
1717
echo
1818
fi
19+
1920
printf "Usage:\n"
2021
printf " git [command] [options]\n"
2122
printf " git [command] --help | -h\n"
@@ -49,6 +50,10 @@ git_status_usage() {
4950
printf "git status - Show repository status\n"
5051
echo
5152
fi
53+
54+
printf "Shortcut: s*\n"
55+
echo
56+
5257
printf "Usage:\n"
5358
printf " git status [options]\n"
5459
printf " git status --help | -h\n"
@@ -73,6 +78,10 @@ git_commit_usage() {
7378
printf "git commit - Commit changes\n"
7479
echo
7580
fi
81+
82+
printf "Shortcut: c*\n"
83+
echo
84+
7685
printf "Usage:\n"
7786
printf " git commit [options]\n"
7887
printf " git commit --help | -h\n"

‎examples/minimal/download‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ download_usage() {
2424
printf "download - Sample minimal application without subcommands\n"
2525
echo
2626
fi
27+
2728
printf "Usage:\n"
2829
printf " download SOURCE [TARGET] [options]\n"
2930
printf " download --help | -h\n"

0 commit comments

Comments
 (0)