note

README

Note

Quick and easy Command-line tool for taking notes

Installation

1. Download the executable for your Operating System at note/releases;
2. Rename the executable to note;
3. Place the executable in a directory loaded by the system (about these directories);
4. Give it permission to be executable (only if you are using Mac OS or Linux).

Or, if you are using a Mac OS or Linux, you can just execute the commands described at the note/releases.

Configurations

The default configuration is:

editor: vim
notePath: ~/Notes

You can create a .noteconfig.yml (or json, or toml) in your home directory to o override these configurations. If you create a configuration file in a specific directory, it will take priority over the default and the configuration in the home directory. As well the EDITOR and NOTE_PATH environment variables has priority over these configuration files.

Usage

note [just type a text] [or command] [with command options]

Options

   --title value, -t value  inform a title for the note

Commands

show                Show a note content
edit, e             Edit a note content
delete, del, d, rm  Delete a note
list, ls, l         List notes
help, h             Shows a list of commands or help for one command

Code Status

License

Note is released under the MIT License.