@@ -5,8 +5,8 @@ Each of these examples demonstrates one aspect or feature of bashly.
5
5
## Basic use
6
6
7
7
- [ minimal] ( minimal#readme ) - the most basic "hello world" example
8
- - [ commands] ( commands#readme ) - a script with sub-commands
9
- - [ commands-nested] ( commands-nested#readme ) - a script with nested sub-commands
8
+ - [ commands] ( commands#readme ) - a script with subcommands
9
+ - [ commands-nested] ( commands-nested#readme ) - a script with nested subcommands
10
10
11
11
## Basic features
12
12
@@ -17,6 +17,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
17
17
- [ dependencies] ( dependencies#readme ) - halting script execution unless certain dependencies are installed
18
18
- [ dependencies-alt] ( dependencies-alt#readme ) - halting script execution unless one of the required dependencies is installed
19
19
- [ environment-variables] ( environment-variables#readme ) - halting script execution unless certain environment variables are set
20
+ - [ variables] ( variables#readme ) - defining bash variables
20
21
- [ default-values] ( default-values#readme ) - arguments and flags with default values
21
22
- [ minus-v] ( minus-v#readme ) - using ` -v ` and ` -h ` in your script
22
23
- [ multiline] ( multiline#readme ) - help messages with multiple lines
@@ -38,14 +39,14 @@ Each of these examples demonstrates one aspect or feature of bashly.
38
39
- [ private-reveal] ( private-reveal#readme ) - allowing users to reveal private commands, flags or environment variables
39
40
- [ stdin] ( stdin#readme ) - reading input from stdin
40
41
- [ filters] ( filters#readme ) - preventing commands from running unless custom conditions are met
41
- - [ commands-expose] ( commands-expose#readme ) - showing sub-commands in the parent's help
42
+ - [ commands-expose] ( commands-expose#readme ) - showing subcommands in the parent's help
42
43
- [ key-value-pairs] ( key-value-pairs#readme ) - parsing key=value arguments and flags
43
44
- [ command-examples-on-error] ( command-examples-on-error#readme ) - showing examples on error
44
45
45
46
## Customization
46
47
47
48
- [ colors-usage] ( colors-usage#readme ) - adding colors to the usage text
48
- - [ command-groups] ( command-groups#readme ) - grouping sub-commands in logical sections
49
+ - [ command-groups] ( command-groups#readme ) - grouping subcommands in logical sections
49
50
- [ custom-strings] ( custom-strings#readme ) - configuring the script's error and usage texts
50
51
- [ custom-includes] ( custom-includes#readme ) - adding and organizing your custom functions
51
52
- [ custom-script-header] ( custom-script-header#readme ) - configuring a different script header
@@ -68,7 +69,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
68
69
## Real-world-like examples
69
70
70
71
- [ docker-like] ( docker-like#readme ) - a sample script with deep commands (like ` docker container run ` )
71
- - [ git-like] ( git-like#readme ) - a sample script with sub-commands similar to git
72
+ - [ git-like] ( git-like#readme ) - a sample script with subcommands similar to git
72
73
73
74
## Documentation generation
74
75
0 commit comments