simplenotesync
version 0.2.0
simplenotesync [options] [pathname]
Options: --help -h brief help message --man full documentation --version -v display program and library version --debug -d write debug output to a logfile in current dir --quiet -q log nothing --email email used for simplenote account --password password used for simplenote account --no_server_updates don't modify notes on server --no_local_updates don't modify notes locally --edit edit a note, preserving xattrs --editor override $ENV{EDITOR} [pathname] is the local notes folder to syncronise with. Defaults to $HOME/Notes. Everything is optional and can be specified in the config file. See manual.
simplenotesync provides bidirectional synchronization between the http://simplenoteapp.com// website and a local directory of text files on your computer
Please note that this software is still in development stages --- I STRONGLY urge you to backup all of your data before running to ensure nothing is lost. If you run simplenotesync on an empty local folder without the net result will be to copy the remote notes to the local folder, effectively performing a backup.
TODO x-platform!
simplenotesync can optionally use a config file. Create a file called simplenotesync.ini in your config dir, usually ~/.config.
It is an ini file, supporting the following keys:
email, password, notes_dir, no_server_updates, no_local_updates, editor
No merging when both local and remote file are changed between syncs - this might be enabled in the future
Renaming a note filename, then changing the contents remotely, will result in two copies of the same note. Also, chaging the notes title remotely will cause it to be downloaded with again with the new name.
For now, you'll have to manually delete the old copy
Certain characters are prohibited in filenames (:,\,/) - if present in the title, they are stripped out.
Simplenote supports multiple notes with the same title, but two files cannot share the same filename. If you have two notes with the same title, only one will be downloaded. I suggest changing the title of the other note.
Do the text files end in .txt or .mkdn? These are currently the only two extensions considered.
Text files can't be located in subdirectories - this script does not (by design) recurse folders looking for files (since they shouldn't be anywhere but the specified directory).
Running with --debug will put a log in the current directory with lots of useful information. If your filing a bug report, I'd like to see that log!
--debug
You can disable writing changes to either the local directory or to the Simplenote web server with "--no_local_updates and --no_remote_updates to protect your data.
--no_local_updates
--no_remote_updates
Designed for use with Simplenote:
<http://www.simplenoteapp.com/>
Based on SimplenoteSync:
<http://fletcherpenney.net/other_projects/simplenotesync/>
Ioan Rogers <ioanr@cpan.org>
Fletcher T. Penney <owner@fletcherpenney.net>
This software is Copyright (c) 2012 by Ioan Rogers.
This is free software, licensed under:
The GNU General Public License, Version 2, June 1991
You can make new bug reports, and view existing ones, through the web interface at https://github.com/ioanrogers/App-SimplenoteSync/issues.
The development version is on github at http://github.com/ioanrogers/App-SimplenoteSync and may be cloned from git://github.com/ioanrogers/App-SimplenoteSync.git
To install App::SimplenoteSync, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::SimplenoteSync
CPAN shell
perl -MCPAN -e shell install App::SimplenoteSync
For more information on module installation, please visit the detailed CPAN module installation guide.