-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
44 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
nimcache/ | ||
omt_save.yaml | ||
omt.yaml | ||
*OSX | ||
*WIN | ||
*LINUX |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,31 @@ | ||
import colorize | ||
|
||
proc showHelp*(): void = | ||
echo """ | ||
omt (one more thing) is a simple CLI tool to get random strings from lists. | ||
By default omt is looking for a configuration file called 'omt.yaml' inside | ||
the directory the command is called. | ||
##### Configuration ##### | ||
An omt config should be written in YAML and consists of two parts: | ||
# Configuration | ||
thingList - a list of strings where omt randomly picks values from | ||
pickedThings - this list could be empty (it will contain picked values in a separate save file after 'omt get' has been run at least once). | ||
An omt config should be written in YAML and consists of two parts: | ||
thingList - a list of strings where omt randomly picks values from | ||
pickedThings - this list could be empty (it will contain picked values in a separate save file after 'omt get' has been run at least once). | ||
##### Commands ##### | ||
omt can be called with the following commands. Appending the '-h' or '--help' flag will show more information for each respective command. | ||
# Commands | ||
help - shows this help | ||
create <projectName> - creates a directory with an empty omt.yaml config | ||
get - Gets a random value from the thingList and by default writes the omt_save.yaml file. | ||
reset - gets rid of omt_save.yaml file. Has to be called inside an omt project. | ||
undo - If an omt_save.yaml file exists inside the current directory <undo> will move the last picked thing back to the 'thingList' | ||
omt can be called with the following commands. Appending the '-h' or '--help' flag will show more information for each respective command. | ||
""" | ||
echo "\thelp".fgGreen & " - shows this help" | ||
echo "\tcreate".fgGreen & | ||
" <projectName> - creates a directory with an empty omt.yaml config" | ||
echo "\tget".fgGreen & | ||
" - Gets a random value from the thingList and by default writes the omt_save.yaml file." | ||
echo "\treset".fgGreen & | ||
" - gets rid of omt_save.yaml file. Has to be called inside an omt project." | ||
echo "\tundo".fgGreen & | ||
" - If an omt_save.yaml file exists inside the current directory <undo> will move the last picked thing back to the 'thingList'" | ||
echo "\n" | ||
quit() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters