https://github.com/grncdr/mmr
Add reminders for yourself in directories
https://github.com/grncdr/mmr
cli cli-app reminders rust
Last synced: 10 months ago
JSON representation
Add reminders for yourself in directories
- Host: GitHub
- URL: https://github.com/grncdr/mmr
- Owner: grncdr
- License: mit
- Created: 2018-03-16T23:55:00.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2018-03-17T10:20:25.000Z (over 8 years ago)
- Last Synced: 2024-11-12T20:11:49.698Z (over 1 year ago)
- Topics: cli, cli-app, reminders, rust
- Language: Rust
- Homepage:
- Size: 9.77 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mmr
## What it is
`mmr` is a little CLI tool that reads a `.mmr` file in your current directory. If the file exists and hasn't been modified in a while, it will print it out. You can control how much is printed, and how long "a while" is with some command line arguments (run `mmr -h` to see what's available). Running `mmr` with no arguments will open the `.mmr` file in your current directory (regardless of whether it exists) in your `$EDITOR`.
## Install it
For now just `git clone` and `cargo install`. Real releases later maybe?
## Use it
Recommended usage is to run `mmr remind` before displaying your command prompt. This will cause mmr to automatically print reminders you haven't seen recently as you `cd` around the file system.
### bash
Add this in your `.bashrc` or `.profile` or whatever (I still can't remember which files bash will use when):
```sh
PROMPT_COMMAND="mmr remind; $PROMPT_COMMAND"
```
### zsh
Add this in your `.zshrc` (or `.profile` etc):
```zsh
precmd() {
mmr remind
}
```
If you already have a `precmd`, put `mmr remind` near the start.
## Other commands
```
mmr 0.1
Stephen Sugden
Leave reminders for yourself in directories
USAGE:
mmr [FLAGS] [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
-r, --recursive Recursively search for .mmr file up to the root of the
filesystem instead of only the current directory.
-V, --version Prints version information
SUBCOMMANDS:
add Append a line to the .mmr file, creating it if necessary.
edit Open the .mmr file in your $EDITOR
help Prints this message or the help of the given subcommand(s)
print Print the contents of the .mmr file regardless of it's age
remind Check for a .mmr file and print the contents if it's old enough
```
## Acknowledgements
This [idea came from @mntmn](https://twitter.com/mntmn/status/974671390845603841), I was bored and I liked it so here we are.