Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tessus/joplin-scripts

scripts for Joplin
https://github.com/tessus/joplin-scripts

backup bash cleanup joplin scripts

Last synced: 16 days ago
JSON representation

scripts for Joplin

Host: GitHub
URL: https://github.com/tessus/joplin-scripts
Owner: tessus
Created: 2019-07-02T18:12:52.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-02-03T20:16:10.000Z (9 months ago)
Last Synced: 2024-10-14T10:16:26.196Z (30 days ago)
Topics: backup, bash, cleanup, joplin, scripts
Language: Shell
Homepage:
Size: 42 KB
Stars: 53
Watchers: 8
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Use at your own risk!

Why are there 2 scripts to remove resources?

The first script `jnrmor` removes orphaned resources from the database and the meta data files for those resources from the sync target. ~~Due to an error in the Joplin API, the actual resources are not deleted on the sync target.
There's where script `jnclnst` comes to the rescue.~~

The default locations for the config files are the path of the script and your home directory. These locations will be shown with the option `--help`.

## Requirements

bash version 4 is required for `jnclnst`. Some scripts use getopt to parse the arguments. Unfortunately the getopt that comes with macOS is a useless piece of shit and can't be used in any useful manner.

### macOS

The best way to install proper versions of `bash` and `getopt` is to either use MacPorts or brew. Make sure the binaries are in the PATH before `/bin` and `/usr/bin`.
Another potential dependency is `jq` (which is required when using newer Joplin versions that stores settings not only in the database, but a json file as well).

#### MacPorts

```
sudo port install bash util-linux jq
```

#### brew

```
brew install bash
brew install gnu-getopt
brew install jq
```

## `jnrmor` - remove orphaned resources in Joplin

```
usage: jnrmor [-c CONFIGFILE] [-f] [-q|--quiet] [-n|--dry-run] [-d|--debug] [-V|--version] [-h] [--help]

-c CONFIGFILE
use CONFIGFILE, instead of searching the default locations
The first file found is used.

-f
run without confirmation

-q, --quiet
do not print informational messages
(errors will be shown)

-n, --dry-run
only show orphaned resources (do not actually delete them)
implies -f

-d, --debug
print debug information

-V, --version
version information

-h
usage information

--help
this help
```

If you rather use a perl script, head over [here](https://github.com/sciurius/perl-Joplin-API). You can use the script `listnotes.pl` with the option `--weed`.

## `jnclnst` - clean sync target (remove orphaned resources from sync target)

This script is no longer needed. A fix was added to Joplin a while back. It’s only here for reference and for people who still use an old Joplin version.
It doesn’t hurt to run the script, it just won’t find anything to remove anything anymore.

```
usage: jnclnst [-c CONFIGFILE] [-f] [-q|--quiet] [-n|--dry-run] [-d|--debug] [-V|--version] [-h] [--help]