Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keyang/notebox
https://github.com/keyang/notebox
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/keyang/notebox
- Owner: Keyang
- License: mit
- Created: 2015-07-21T23:12:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-02T09:06:37.000Z (over 6 years ago)
- Last Synced: 2024-08-09T17:35:32.464Z (6 months ago)
- Language: JavaScript
- Size: 453 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Note Box
Note box is a sqlite3 based Node.JS application which helps taking notes
in command line. It has following features:
* Completely Offline.
* Note tags.
* Password protection: AES256 encryption
* Simple Commands
* PIPE and Stream Support
* full text search / tag based search
* Single db file. easy to backup and migrate.
## Installation
```
npm install -g notebox
```
# CheatSheet (A way to notebox ninja)
## New note
```
nb n "this is my note"
```
Multiple line note
```
nb n
```
Stream data from a file
```
nb n < myfile
```
Set tags (separated by comma)
```
nb n -t tag1,tag2,tag3 "Hell world"
```
Store binary file with a title
```
nb n --title mypdf.pdf
```
list all note
```
nb s
```
remove all found items (find and remove)
```
nb s -t personal_tag --delete
```
extract stored file
```
nb s mypdf.pdf -o raw > mypdf.pdf
```
export a password protected file
```
nb s mypic.png -p -o raw >mypic.png
```
## Update
Use $EDITOR to change note data.
```
nb u
```
Update password
```
nb u -p
```
## Note Editor
Change $EDITOR env var to the path of your editor so that you can create note,
update note using the editor.
## Others
Shrink DB file
```
nb sql "vacuum;"
```
Use different db file
```
db n -d
```
##More
see
```
nb help
```
#Encrypted Database
By default, sqlite database is not encrypted. Although password protected notes are aes256 encrypted, it is nice to have whole database file encrypted.
To do this, once notebox is installed, goto the installation folder and re-build / configure node-sqlite in node_modules folder.
Here is how:
https://github.com/mapbox/node-sqlite3#building-for-sqlcipher