Memoire

Memoire 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.

Installation

Make sure you have Cargo installed.

Install with: sh cargo install memoire

Usage

CLI

• Show all records: sh memoire
• General search: sh memoire [-s|--search] <keyword_1> <keyword_2> ...
• Search by command: sh memoire [-c|--command] <keyword_1> <keyword_2> ...
• Search by annotation: sh memoire [-a|--annotation] <keyword_1> <keyword_2> ...
• Search by tags: sh memoire [-t|--tags] <keyword_1> <keyword_2> ...
• You can combine arguments: sh memoire -c <keyword_1> -t <keyword_2> ...
• By default, search results calculate the union of search results of each keyword. For intersection add -i: sh memoire [-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.

TLDR Pages Import

Too lazy to build your own archive? No worries, you can import tldr pages to Memoire.

Following rules are applied when converting tldr-pages to Memoire bookmark: - Command name -> Tag - Example description -> Annotation - Command example -> Command

You can import individual tldr page by passing file's path. E.g. to import pages/common/aws run: sh memoire --tldr pages/common/aws

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

Memoire is under Apache 2.0 License.