mme is a search tool that helps you to print commands and their description using a custom file.
Installation
The binary name for rememberme is mme.
Archives of precompiled binaries for rememberme are available for macOS, Windows and Linux.
Usage
USAGE:
mme.exe [FLAGS] [OPTIONS] [word-to-search]
FLAGS:
--help Prints help information
-a, --all Prints all the commands and their descriptions
-d, --desc Searches the word only in descriptions
-n, --name Searches the word only in names
-V, --version Prints version information
OPTIONS:
-f, --fixed-color <fixed-color> Sets the color of NAME, DESC words
-h, --highlight-color <highlight-color> Sets the color of the highlighted word
-p, --path <path> Sets the path of the file where mme is going to search
-t, --text-color <text-color> Sets the color of the text
ARGS:
<word-to-search> Word to search in the document specified in the configuration
Examples
Basic configuration
You need to specify the path of the file that contains your commands.
mme --path ~/my_commands
The file where mme
is going to search must have the following structure:
# veryComplexCommand -a
> A very explanatory description
# veryComplexCommand
-b
-c
-d
> A very explanatory description
-b means b
-c means c
-d means d
The #
indicates a command and >
its corresponding description, you need to leave a blank line to separate the commands.
Extra configuration
You can change the color of the titles and the text. The available colors are: black, red, green, yellow, blue, purple, cyan and white.
mme --primary-color blue --secondary-color green
Searching
You can search by all (name and description):
mme veryComplexCommand
Only by name:
mme -n veryComplexCommand
Only by description:
mme -d veryComplexCommand
Special Searching
If you want to search a word with special characters you need to add --
after you enter all the flags:
mme -d -- -something