__ ____ __
_____/ /_ ___ / / /___ ____ / /____
/ ___/ __ \/ _ \/ / / __ \/ __ \/ __/ _ \
(__ ) / / / __/ / / / / / /_/ / /_/ __/
/____/_/ /_/\___/_/_/_/ /_/\____/\__/\___/
$ easy note-taking on the command line.
The idea behind shellnote is to enable quick note-taking while you're working or reading. If an idea pops into your head, or you need to remember something, just jot down in your terminal:
$ shellnote -a "This is a great idea."
Your entry will be saved with a timestamp in a tab-delimited text file. You can print the entry log using the -p flag:
$ shellnote -p
2020-08-29 19:57 Richard Stallman really whips the llama's ass.
2020-08-29 20:12 Make sure to drink your Ovaltine.
2020-08-29 20:24 This is a great idea.
You can search your notes (-s) and delete entries (-d) directly from the command line.
shellnote is POSIX-compliant and should work in most Unix shells.
To install, download this repo and run the setup-script ('#' means the command requires an elevated shell, which can be accessed with e.g. sudo):
$ git clone https://github.com/mrtgst/shellnote.git
$ cd shellnote
# ./setup install
This will copy shellnote to /usr/local/bin/.
To create a handy note shorthand you can create an alias in your shell's config or aliases file; e.g., if you use bash:
$ echo "alias note='shellnote'" >> "$HOME"/.bashrc
To remove shellnote, call the above setup-script with
# ./setup uninstall
This will also delete the global configuration file, but not your personal one or your notes.
The install script creates a config file /etc/shellnote/shellnote.conf with the default configuration.
You can create a user config file in ~/.config/shellnote/shellnote.conf. The settings in this file will take precedence.
Written by Martin Gustavsson, released under GPLv3 license.