view release on metacpan or  search on metacpan

bin/simplenotesync  view on Meta::CPAN

  [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.

=head1 DESCRIPTION

C<simplenotesync> provides bidirectional synchronization between the L<http://simplenoteapp.com/>/ website
and a local directory of text files on your computer

=head1 WARNING

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 C<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.

=head1 CONFIGURATION

TODO x-platform!

C<simplenotesync> can optionally use a config file. Create a file called 
F<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

=head1 KNOWN ISSUES

=over

=item

No merging when both local and remote file are changed between syncs - this might be enabled in the future

=item

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

=item

Certain characters are prohibited in filenames (:,\,/) - if present in the
title, they are stripped out.

=item

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.

=back

=head1 FAQ

=over

=item B<Why can I download notes from Simplenote, but local notes aren't being uploaded?>

Do the text files end in F<.txt> or F<.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).

=back

=head1 TROUBLESHOOTING

Running with C<--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!

You can disable writing changes to either the local directory or to the 
Simplenote web server with "C<--no_local_updates> and C<--no_remote_updates> to
protect your data.

=head1 SEE ALSO

Designed for use with Simplenote:

<http://www.simplenoteapp.com/>

Based on SimplenoteSync:

<http://fletcherpenney.net/other_projects/simplenotesync/>

=head1 AUTHORS

=over 4

=item *

Ioan Rogers <ioanr@cpan.org>

=item *

Fletcher T. Penney <owner@fletcherpenney.net>

=back

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2021 by Ioan Rogers.

This is free software, licensed under:

  The GNU General Public License, Version 2, June 1991

=head1 BUGS AND LIMITATIONS

You can make new bug reports, and view existing ones, through the
web interface at L<https://github.com/ioanrogers/App-SimplenoteSync/issues>.

=head1 SOURCE

The development version is on github at L<https://github.com/ioanrogers/App-SimplenoteSync>
and may be cloned from L<git://github.com/ioanrogers/App-SimplenoteSync.git>