memo-sh

Easy and fun management of your memos and notes. Inspired by github.com/mattn/memo

Features

Create memos with custom path formats, e.g. %Y-%m/%d/{SLUG}.md
Displays a tree hierarchy of your memos
Quickly edit a memo with fuzzy selectors like fzf, peco, etc.
Fast grep search throughout memos with ag, ack, grep, etc.

Requirements

tree, or change $MEMO_TREE
the-silver-searcher, or change $MEMO_GREP
$EDITOR set to your favorite editor

Install

Simply copy the single script, for example:

$ cd ~/.local/bin
$ curl -LO https://github.com/rafi/memo-sh/raw/master/memo
$ chmod ug+x memo

Usage

memo [global options] <command> [command options]

COMMANDS:
  new, n     create memo
  list, l    list memo
  edit, e    edit memo
  delete, d  delete memo
  grep, g    grep memo
  config, c  configure
  serve, s   serve memos over http
  help, h    list of commands

GLOBAL OPTIONS:
  --help, -h      show help
  --disable-yaml  disable yaml matter
  --version, -v   print the version

Configuration

Configuration via environment-variables:

EDITOR - Preferred user editor
MEMO_DIR - Base directory for all memos, default: ~/.local/share/memo
MEMO_FMT - Format for new memos, default: %Y-%m/%d-{SLUG\}.md
MEMO_GREP - Command to use for grep, default: ag (the silver searcher)
MEMO_TREE - Command to use for list, default: tree -FR --dirsfirst
MEMO_SELECT - Command to use for selecting a single memo, default: fzf

Credits

Inspiration came from memo by Yasuhiro Matsumoto (a.k.a. @mattn)

Similar Projects

Memo - Go application with internal Markdown server
Notes

License

MIT License, created by Rafael Bodill

rafi / memo-sh