74 lines
2.3 KiB
Markdown
74 lines
2.3 KiB
Markdown
Vim Note System
|
|
==================
|
|
|
|
## About
|
|
Vim Note System is a shell script partially inspired by [pass].
|
|
vns stores notes as asymmetrically encrypted plaintext using the
|
|
vim-gnupg plugin.
|
|
|
|
VNS, formerly SNS, was originally conceived one morning during an update
|
|
to a popular note-taking app. The thought occurred that a note system need
|
|
not reinvent the wheel with its own GUI editor and proprietary file format,
|
|
but instead could use the tools already provided by the operating system.
|
|
|
|
usage: vns [-cdelpqr] <notebook/section/name>
|
|
vns -I GPG_RECIPIENT (GPG_RECIPIENTS...)
|
|
vns -h
|
|
vns git ...
|
|
|
|
-c : Create note
|
|
-d : Delete note(s)
|
|
-e : Open note for editing
|
|
-h : Display this message
|
|
-i : import file as note
|
|
-I : Initialize note store
|
|
-j : Open Daily Journal Entry
|
|
-l : List all notes in <notebook>
|
|
-m : Merge two or more notes
|
|
-p : Print note to console
|
|
-q : Query notes for expression
|
|
-r : Rename/move a note
|
|
-u : Duplicate note as given path
|
|
|
|
## Installing
|
|
### Dependencies
|
|
* vim
|
|
* gpg2
|
|
* tree
|
|
* git
|
|
|
|
** Note: ** Install [vim-gnupg] before use. vns does not verify notes encrypt successfully.
|
|
|
|
To install, place `vns` in your path, and run `vns -I`.
|
|
|
|
vim note system will establish its note store under ~/.vns.
|
|
The location of the store may be changed on line 4, or via the envioronment
|
|
variable VNS_STORE.
|
|
|
|
To uninstall, remove the files you copied. Notes will still exist in ~/.vns
|
|
|
|
## Tips and Tricks
|
|
* To list all notes in all notebooks, simply run `vns`.
|
|
* Notes beginning with . will not appear in the listing
|
|
|
|
## Credits
|
|
The code here is my own, however much of VNS's design and behavior was
|
|
influenced by [pass].
|
|
|
|
ZSH Completion is heavily modified, but adapted from pass's zsh completion file
|
|
as an example.
|
|
|
|
## License
|
|
Vim Note System is licensed under the terms of the GNU General Public License
|
|
Version 2, as detailed in `LICENSE`.
|
|
|
|
## Bugs and Feature Requests
|
|
If something seems off, or just doesn't work, please open an issue and I'll look
|
|
into it.
|
|
|
|
Feature requests should be submitted to xenami@xenami.net with [VNS Feature Request]
|
|
in the subject line.
|
|
|
|
[pass]: http://passwordstore.org
|
|
[vim-gnupg]:http://www.vim.org/scripts/script.php?script_id=3645
|