https://github.com/JLiscom/OpenNote-CLI
https://github.com/JLiscom/OpenNote-CLI
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/JLiscom/OpenNote-CLI
- Owner: JLiscom
- License: mit
- Created: 2017-12-28T23:25:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-04T20:03:09.000Z (almost 7 years ago)
- Last Synced: 2025-02-28T23:21:23.643Z (3 months ago)
- Language: JavaScript
- Size: 54.7 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenNote CLI
Open Note CLI is, well, a CLI client for OpenNote.
[OpenNote](https://github.com/FoxUSA/OpenNote/) is HTML5 progressive/Offline webapp that is: a minimal, text focused, note taking software that supports tree structures and tags. The datastore is CouchDB mostly because it take like 5 lines to have bi-directional sync.
## Install
This is designed to be installed in your path. This is for multiple notebook support. Much like Git, to have another notebook just create another folder somewhere. The `.openNote` contains localDB and CouchDB replication url. Then install in your path
```
sudo cp opennote-cli-linux /usr/local/bin/opennote
sudo cp -r node_modules/ /usr/local/bin/
```
## Help file
```
node index.js
index.js 18.03.0-Alpha - CLI client for OpenNote
USAGE
index.js [options]
COMMANDS
sync [mode] Sync with CouchDB server
config Creates .openNote folder and sets replication url required properties
delta
save
help Display help for a specific command
GLOBAL OPTIONS
-h, --help Display help
-V, --version Display version
--no-color Disable colors
--quiet Quiet mode - only displays warn and error messages
-v, --verbose Verbose mode - will also output debug messages
```
---
## Example Workflow
```
# Setup
node index.js config http://admin:[email protected]:5984/opennote
# Pull down files
node index.js sync write
# Edit some files with your editor of choice.
nano reallyCoolFolder/note.md
# Show me my changes
node index.js delta
# Save my changes into the local copy of the db
node index.js save
# Sync my local db to the remote server
node index.js sync
```
---
## FAQ
### Can I use this without the web client or CouchDB?
You could but I have no idea why you would want to. Its basically Git without the branches. IE cookies without sugar. Whole idea is its an eco system. Read and modify notes if you are offline and sync them around.
### Can you use Mongo as a datastore
No.
### I don't like _______ please fix it!
This code is Open Source Software (OSS). You are welcome to take the code and fork it.
### Fun use cases?
- As a text editor, akin to notepad, in your browser!
- Use with Git to allow history. Just do a `git init` in the parent folder and marvel at the `.git` and `.opennote` support folders.