kevin/vnotes
1
0
Fork 0
mirror of https://github.com/prurigro/vnotes.git synced 2024-11-21 17:02:31 -05:00
Code Issues Projects Releases Packages Wiki Activity
Manage your notes with flat files and your system text editor
6 commits 1 branch 0 tags 45 KiB
Shell 100%
Find a file
Kevin MacMartin bd83c4081d Minor improvements and cleanup: 
* Declare global variables globally
* Group functions related to note searching together
* Add colour to the "Can't find" error
* Add more comments to explain what different blocks of code are doing
2023-08-23 21:56:41 -04:00
LICENSE Include MIT license 2023-08-23 18:26:05 -04:00
readme.md Add "vnotes" to the usage patterns 2023-08-23 18:22:49 -04:00
vnotes Minor improvements and cleanup: 2023-08-23 21:56:41 -04:00

readme.md

vnotes

Manage your notes with flat files and your system text editor

Dependencies

Configuration

Configuration is handled using environment variables:

  • EDITOR: The text editor that should be used to open notes (default: /usr/bin/vim)
  • VNOTES_FOLDER: The folder notes should be managed in (default: $HOME/Notes)
  • VNOTES_EXTENSION: The file extension notes should have (default: md)

Usage

  • vnotes [PATTERN]: If multiple notes include [PATTERN] a list of matching notes is presented to choose from, otherwise it opens the closest matching note
  • vnotes -c|--create [NAME]: Creates a new note named [NAME]
  • vnotes -d|--delete [NAME]: Deletes the note named [NAME]
  • vnotes -h|--help: Shows the help text