note

a new command, ($ note) to help you take notes. Gives fast ability to add notes to your notes file through the note command or open up your selected notes file for an interactive edit.

installation (Linux / Mac OS)

• create the notes file storage. If you would like another file storage path, then you should use a new path and also update the note_taker.bash file with the correct NOTE_PAD_PATH

$ touch $HOME/.notes_for_note_taker.txt

Execute the install script with root privileges. Either change directory cd to the downloaded directory (or local repository): note_taker, or use the path to the installation file (i.e. ./[PATH_TO_FILE]/install.bash).

$ sudo ./install.bash

• Note: This script creates a copy of the repository in the directory /opt/note_taker/; the update, overwrites that copy. Then a symbolic link is created in the directory /usr/local/bin/, which is generally designated for user programs not managed by the distribution package manager

• you can specify the command if you don't like note

• The editor for interactive and edit options is set to the global editor defined in your git config file or if unset, it is vim. To set your default editor for note command, use this command:

git config --global core.editor "emacs"

Usage

$ note [abcefptu] [NS] [<SUBJECT>] [<MESSAGE_LINE_1>] [<MESSAGE_LINE_2>] ...

The execution command for the note taker can be specified by user choice during installation or manually.

• usage with no options to add notes

$ note "<A_NEAT_SUBJECT_GOES_HERE>" "This one line of a Note" "and another line to document" ...

Options

• Usage with options for management

$ note [-abcefptu] [NS]

-a     all pipes the entire notes file through less for quick analysis

-b         backup, creates copy of note taker file with a hash extension as a backup

-c     clear clears all notes in the notes file

-e        interactive edit of your notes, no timestamp added

NOTE: see the install instructions to set your editor of choice for -e

-f S     find string matching S (regex enabled) using:

grep --ignore-case --before-context=3 --after-context=3 --color --extended-regexp "$2"

-p        paste, adds pbpaste (clipboard) content to note pad

-t N     tail output last N lines of notes (N is optional, defaults to 10)

-u     undo deletes the most recent note in the notes file. Specifically, it deletes the text-to-last line and continues deleting lines upwards until it enounters another blank line. This works well with notes made using the program prompt but may produce unexpected results if the notes file has been interactively edited and no longer follows the default formatting.

license

MIT License

author

• David John Coleman II, http://www.davidjohncoleman.com

contributors

• Nick Julian, https://github.com/JiveCatDaddyO
• Luis E. Jiménez, https://github.com/luisejrobles