Memoir

Memoir is a TUI program to help you archive commands (or any text).

You can search archived commands by keywords in command, annotation and/or tags. The archived commands are editable and deletable. Archived commands are saved in json format for easy sharing.

Usage

CLI

• Show all records:

  memoir
  

• General search:

  memoir [-s|--search] <keyword_1> <keyword_2> ...
  

• Search by command:

  memoir [-c|--command] <keyword_1> <keyword_2> ...
  

• Search by annotation:

  memoir [-a|--annotation] <keyword_1> <keyword_2> ...
  

• Search by tags:

  memoir [-t|--tags] <keyword_1> <keyword_2> ...
  

• You can combine arguments:

  memoir -c <keyword_1> -t <keyword_2> ...
  

• By default, search results calculate the union of search results of each keyword. For intersection add -i:

  memoir [-i|--intersection] -c <keyword_1> -t <keyword_2> <keyword_3> ...
  

TUI

• Ctrl-c: Quit program at any time.
• Up / Down: To move between options or panels.
• Enter: To select option.
• Ctrl-a: To add new record.
• Left / Right: To move cursor in input_mode.

Requirement

This program use rust-clipboard which requires x11 on Linux.

It's Not a Bug, It's a feature (aka Will fix)

1. In input mode the cursor moves out of border if text exceeds 1 line.

What's next

• Copy & paste in input mode.
• Unit tests.
• A system to share, update and manage json files. Or parse existing command collection to json.
• Alternative TUI libraries:
  • cursive
  • titik
• Look into option to switch out InputDialog with existing dialog libraries:
  • dialoguer
  • dialog

Q & A

1. How to retrieve record id from CLI?

   ¯\(ツ)/¯

2. Why are you handling errors like an amateur?

   But I am an amateur...

License

Memoir is under Apache 2.0 License.