https://github.com/GoberInfinity/mme
Remember me my commands
https://github.com/GoberInfinity/mme
Last synced: about 1 month ago
JSON representation
Remember me my commands
- Host: GitHub
- URL: https://github.com/GoberInfinity/mme
- Owner: GoberInfinity
- License: mit
- Created: 2020-02-15T21:29:25.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-07T05:58:09.000Z (over 4 years ago)
- Last Synced: 2024-11-04T09:37:13.503Z (6 months ago)
- Language: Rust
- Size: 410 KB
- Stars: 27
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - GoberInfinity/mme - Remember me my commands (others)
README
# 
[](https://travis-ci.org/GoberInfinity/mme)
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.](https://github.com/GoberInfinity/mme/releases)
## 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 Sets the color of NAME, DESC words
-h, --highlight-color Sets the color of the highlighted word
-p, --path Sets the path of the file where mme is going to search
-t, --text-color Sets the color of the text
ARGS:
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.
```bash
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.
```bash
mme --primary-color blue --secondary-color green
```
#### Searching
You can search by all (name and description):
```bash
mme veryComplexCommand
```
Only by name:
```bash
mme -n veryComplexCommand
```
Only by description:
```bash
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:
```bash
mme -d -- -something
```