diff --git a/README.md b/README.md index 4f162eb..c58cc0d 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,16 @@ gh repo create rwxrob/mycmd -p rwxrob/template-bash-command This `cmd` inside can then be renamed and finished. -Obviously, not all of this is needed for many Bash scripts, but anything -with more than two subcommands will benefit from the builtin tab -completion, embedded Markdown help documentation support, and included -functions (`usage`, `_filter`, `_buffer`, `_have`, etc.) +Obviously, not all of this is needed for many Bash scripts. Just remove +what you do not need or want. If you want to keep a command but hide it +from users just add another underscore to the prefix which turns it into +a hidden command, which will not be included in help documentation and +tab completion, but will still be there. The `readme` command (which +generates this `README.md` file is a good candidate for this.) + +Be sure to check out the builtin and utility functions. Some of these + +can be removed as well if you really want. ## Naming Conventions @@ -81,6 +87,9 @@ cmd config cmd config KEY cmd config KEY VALUE cmd config KEY "" +cmd config dir +cmd config path [file] +cmd config edit [file] ``` The `config` command is for reading, writing, and displaying standard @@ -93,10 +102,11 @@ With no arguments outputs all the currently cached configuration settings. With a single KEY argument fetches the value for that key and outputs -it. The special `dir` KEY is reserved and always outputs the full path -to the current configuration directory containing the `values` file. The -special `path` KEY is reserved and always outputs the full path to the -`values` file itself. +it unless it is one of the following special (reserved) key names: + +* `dir` full path to config directory +* `path` full path to specific config file (default: `values`) +* `edit` opens config file in editor (default: `editor` or `$EDITOR) With more than one argument the remaining arguments after the KEY will be combined into the VALUE and written to a `values` file in the @@ -179,5 +189,5 @@ Displays a summary of usage. ---- -*Autogenerated Wed Aug 25 12:52:34 AM EDT 2021* +*Autogenerated Fri Aug 27 09:16:17 AM EDT 2021* diff --git a/cmd b/cmd index c92fb09..55fccc5 100755 --- a/cmd +++ b/cmd @@ -27,10 +27,16 @@ gh repo create rwxrob/mycmd -p rwxrob/template-bash-command This `cmd` inside can then be renamed and finished. -Obviously, not all of this is needed for many Bash scripts, but anything -with more than two subcommands will benefit from the builtin tab -completion, embedded Markdown help documentation support, and included -functions (`usage`, `_filter`, `_buffer`, `_have`, etc.) +Obviously, not all of this is needed for many Bash scripts. Just remove +what you do not need or want. If you want to keep a command but hide it +from users just add another underscore to the prefix which turns it into +a hidden command, which will not be included in help documentation and +tab completion, but will still be there. The `readme` command (which +generates this `README.md` file is a good candidate for this.) + +Be sure to check out the builtin and utility functions. Some of these + +can be removed as well if you really want. ## Naming Conventions