man(1)

📦 version 1.7.1, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 NAME 💖

memo — unix-style note-taking software. yes bestie, it's literally a tiny note app for your terminal. this is the man(1) page for it, and we're gonna walk through the whole thing together 🫶

🌸 SYNOPSIS 🌸

memo [OPTIONS]

✨ DESCRIPTION ✨

okay so. Memo is note-taking software for POSIX compatible operating systems. that's it, that's the vibe — little short notes, living in your home directory, saved to the ~/.memo file by default. no cloud, no drama, no "create an account" nonsense. just notes ✨

🎀 OPTIONS 🎀

  • -a, --add <content> [yyyy-MM-dd] — add a brand new note 🌱
  • -d, --delete <id> — delete a note by its id, bye bye 👋
  • -D, --delete-all — delete all the notes. all of them. gone 💀
  • -e, --export <format> <path> — export your notes to a file. <format> has to be either csv or html (those are the only two, don't try to be creative) 📤
  • -f, --search <search> — find notes by text search 🔍
  • -F, --regex <regex> — find notes by regular expression, for the regex girlies 🧚
  • -i, --stdin — add multiple notes from stdin, bulk mode activated 📥
  • -l, --latest <n> — show the latest n notes 🕐
  • -m, --set-done <id> — mark a note's status as done ✅
  • -M, --set-undone <id> — mark a note's status as undone ↩️
  • -o, --list-date — show all notes organized by date 📅
  • -O, --organize — reorder and organize the note id codes, a lil cleanup moment 🧹
  • -p, --path — show the current memo file path 📍
  • -P, --postpone [id] — show postponed notes, or mark a note as postponed ⏳
  • -R, --delete-done — delete all the notes marked as done 🗑️
  • -r, --replace <id> [content]/[yyyy-MM-dd] — replace a note's content or its date ✏️
  • -s, --list — show all notes except postponed ones. same thing as just typing the command memo 📋
  • -T, --set-done-all — mark all the notes as done ✅✅
  • -u, --list-undone — show only the undone notes 🌱
  • - — read from stdin 🫶
  • -h, --help — show the short help and exit. this page, right here 👑
  • -V, --version — show the version number of the program 🔢

🍓 EXAMPLES 🍓

Add a new note:

memo -a "Remember to buy milk!"

Add a new note with custom date:

memo -a "File taxes" 2014-10-14

Search memos by string:

memo -f buy

Output:

4    2014-10-10    Remember to buy milk

Replace record 4 with new text:

memo -r 4 "Remember to buy cheese"

Add note from stdin:

echo "My new note" | memo -

Mark note as postponed:

memo -P 4

Show postponed notes:

memo -P

Postponed notes are not shown by default — they're lowkey hiding 🙈. A postponed note can be marked as undone or done normally using the -m or -M flag. and heads up: only undone notes can be postponed. that's the rule, no exceptions.

It's possible to change the location (and name) of the .memo file. Create $HOME/.memorc (or $XDG_CONFIG_HOME/.memorc) with a line MEMO_PATH=/path/you/would/like , and Memo will use that path instead of the default $HOME/.memo path. cute, right? 💅

It's also possible to set the memo path using an environment variable. For example: export MEMO_PATH=/path/to/some/file. If the MEMO_PATH environment variable is set, that will be used. If it's not set, Memo will try to read .memorc for MEMO_PATH. If the file does not exist or has errors, Memo will use the $HOME/.memo file to store the notes.

Since version 1.3, the -D option asks for confirmation before deleting all notes. It's possible to disable this confirmation via a .memorc property. To disable the confirmation, add MEMO_CONFIRM_DELETE=no to the .memorc file.

Since version 1.5, it's possible to set a property MARK_AS_DONE in .memorc. The property takes a valid date as a value. For example: MARK_AS_DONE=2014-12-23. If the property is set, Memo will mark all notes older than the property value as done automatically.

💅 NOTES 💅

On some terminal emulators with Bash you can't use an exclamation mark if the Bash history expand feature is enabled. For example: memo -a "This is a test note!" 2014-12-20 would fail. Some terminal emulators workaround this (Gnome Terminal for example). You might want to disable Bash history expand if you don't use it by putting set +H to your ~/.bashrc.

Please note, that this is not a bug in Memo, or in Bash. It's a feature of Bash. bestie it's not a bug it's a feature, iykyk 😭

📁 FILES 📁

  • $HOME/.memo
  • $HOME/.memorc
  • $XDG_CONFIG_HOME/.memorc

🌈 COLORS 🌈

Since version 1.6, Memo has support for colors 🎨. Color support can be enabled in .memorc by setting USE_COLORS=yes. By default Memo uses blue for odd lines and magenta for even lines. These can be modified via the .memorc properties LINE_COLOR and ODD_LINE_COLOR. Supported colors are:

  • red
  • cyan
  • green
  • blue
  • black
  • brown
  • magenta
  • gray
  • none

👑 AUTHORS 👑

Written by Niko Rosvall and contributors. iconic honestly.

Copyright (C) 2014-2020 Niko Rosvall <niko@byteptr.com>

Released under license GPL-3+. For more information, see http://www.gnu.org/licenses

and that's the whole page, bestie!! 🦋 this was memo, version 1.7.1, dated 5 Apr 2020 — go forth and take the cutest little notes, mwah 💋🎀

📦 where this page comes from