Quick and easy Command-line tool for taking notes
- Download the executable for your Operating System at note/releases;
- Rename the executable to
- Place the executable in a directory loaded by the system (about these directories);
- 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.
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
NOTE_PATH environment variables has priority over these configuration files.
note [just type a text] [or command] [with command options]
Note is very easy and simple to use.
Start by typing
note command and continue describing what you want to take as note:
note there is no place like home
If using special character, just use quotes or escape the character:
note "there's no place like home"
note there\'s no place like home
It will create a file named
0 - there's no place like home at the notePath.
In case of you need a text editor you can just type
note without any argument.
It will open the
EDITOR defined as environment variable or the configured one.
To define a title, just use the flag option
If no title is informed,
note will take some words from the first line as it.
All titles start with a number (integer) increasing by one from the last note for better identification.
Show a note content. It will search for a note using the given arguments executing a fuzzy search:
note show like home
If it's your first note, you can surely show it by typing:
note show 0
The search is case insensitive, use the flag option
-s if you want to match the case.
Edit a note content. Like the show command, will use the given arguments to search for a note but will open it content in your text editor.
note edit 0
note e 0
Edit Note's title
Edit the title of a note.
It's the edit command with
-t flag option.
So you can rename a note title:
note edit --title renamed 0
note edit -t renamed 0
Delete a note.
Like show and edit, but delete a note.
It will ask for confirmation if not given the flag option
note delete 0
note del 0
note d 0
note rm 0
Has no arguments. Simply list the notes at the
Note is released under the MIT License.
There is no documentation for this package.