Skip to content

Instantly share code, notes, and snippets.

@willsheppard

willsheppard/joplin_help.log

Created August 24, 2024 13:28
Show Gist options
  • Save willsheppard/cff2e8994efeedc3de7af0690b50d0ce to your computer and use it in GitHub Desktop.
Save willsheppard/cff2e8994efeedc3de7af0690b50d0ce to your computer and use it in GitHub Desktop.
Download ZIP
Joplin help log
Raw
joplin_help.log
This shows that Joplin doesn't make it easy enough to set up sync the first time, doesn't provide enough signposts, and is very slow.
```
root@localhost:~# joplin help
(node:4786) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
Type `help [command]` for more information about a command; or type `help all` for the complete usage information.
The possible commands are:
attach, batch, cat, config, cp, done, e2ee, edit, export, geoloc, help, import, ls, mkbook, mknote, mktodo, mv, ren, restore, rmbook, rmnote, server, set, status, sync, tag, todo, undone, use, version
In any command, a note or notebook can be referred to by title or ID, or using the shortcuts `$n` or `$b` for, respectively, the currently selected note or notebook. `$c` can be used to refer to the currently selected item.
To move from one pane to another, press Tab or Shift+Tab.
Use the arrows and page up/down to scroll the lists and text areas (including this console).
To maximize/minimize the console, press "tc".
To enter command line mode, press ":"
To exit command line mode, press ESCAPE
For the list of keyboard shortcuts and config options, type `help keymap`
root@localhost:~# joplin server
(node:4897) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
Missing required argument: command
root@localhost:~# time joplin help
(node:5046) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
Type `help [command]` for more information about a command; or type `help all` for the complete usage information.
The possible commands are:
attach, batch, cat, config, cp, done, e2ee, edit, export, geoloc, help, import, ls, mkbook, mknote, mktodo, mv, ren, restore, rmbook, rmnote, server, set, status, sync, tag, todo, undone, use, version
In any command, a note or notebook can be referred to by title or ID, or using the shortcuts `$n` or `$b` for, respectively, the currently selected note or notebook. `$c` can be used to refer to the currently selected item.
To move from one pane to another, press Tab or Shift+Tab.
Use the arrows and page up/down to scroll the lists and text areas (including this console).
To maximize/minimize the console, press "tc".
To enter command line mode, press ":"
To exit command line mode, press ESCAPE
For the list of keyboard shortcuts and config options, type `help keymap`
real 0m9.793s
user 0m3.383s
sys 0m1.813s
root@localhost:~# joplin sync
(node:5238) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
Not authenticated with (None). Please provide any missing credentials.
root@localhost:~# joplin status
(node:5359) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
# Attachments
Not downloaded: 0
Downloading: 0
Downloaded and decrypted: 0
Downloaded and encrypted: 0
Created locally: 0
Error: 0
# Sync status (synced items / total items)
Note: 0/0
Folder: 0/0
Resource: 0/0
Tag: 0/0
NoteTag: 0/0
Revision: 0/0
Total: 0/0
Conflicted: 0
To delete: 0
# Notebooks
root@localhost:~# joplin help sync
(node:5471) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
sync
Synchronizes with remote storage.
--target <target> Sync to provided target (defaults to sync.target config value)
--upgrade Upgrade the sync target to the latest version.
--use-lock <value> Disable local locks that prevent multiple clients from synchronizing at the
same time (Default = 1)
root@localhost:~# joplin help config
(node:5621) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
config [name] [value]
Gets or sets a config value. If [value] is not provided, it will show the value of [name]. If
neither [name] nor [value] is provided, it will list the current configuration.
-v, --verbose Also displays unset and hidden config variables.
--export Writes all settings to STDOUT as JSON including secure variables.
--import Reads in JSON formatted settings from STDIN.
--import-file <file> Reads in settings from <file>. <file> must contain valid JSON.
Possible keys/values:
sync.target Synchronization target.
The target to synchronize to. Each sync target may have
additional parameters which are named as `sync.NUM.NAME` (all
documented below).
Type: Enum.
Possible values: 0 ((None)), 2 (File system), 3 (OneDrive), 5
(Nextcloud), 6 (WebDAV), 7 (Dropbox), 8 (S3 (Beta)), 9 (Joplin
Server (Beta)), 10 (Joplin Cloud).
Default: 0
sync.2.path Directory to synchronize with (absolute path).
Attention: If you change this location, make sure you copy all
your content to it before syncing, otherwise all files will be
removed! See the FAQ for more details:
https://joplinapp.org/help/faq
Type: string.
sync.5.path Nextcloud WebDAV URL.
Attention: If you change this location, make sure you copy all
your content to it before syncing, otherwise all files will be
removed! See the FAQ for more details:
https://joplinapp.org/help/faq
Type: string.
sync.5.username Nextcloud username.
Type: string.
sync.5.password Nextcloud password.
Type: string.
sync.6.path WebDAV URL.
Attention: If you change this location, make sure you copy all
your content to it before syncing, otherwise all files will be
removed! See the FAQ for more details:
https://joplinapp.org/help/faq
Type: string.
sync.6.username WebDAV username.
Type: string.
sync.6.password WebDAV password.
Type: string.
sync.8.path S3 bucket.
Attention: If you change this location, make sure you copy all
your content to it before syncing, otherwise all files will be
removed! See the FAQ for more details:
https://joplinapp.org/help/faq
Type: string.
sync.8.url S3 URL.
Type: string.
Default: "https://s3.amazonaws.com/"
sync.8.region S3 region.
Type: string.
sync.8.username S3 access key.
Type: string.
sync.8.password S3 secret key.
Type: string.
sync.8.forcePathStyle Force path style.
Type: bool.
Default: false
sync.9.path Joplin Server URL.
Attention: If you change this location, make sure you copy all
your content to it before syncing, otherwise all files will be
removed! See the FAQ for more details:
https://joplinapp.org/help/faq
Type: string.
sync.9.username Joplin Server email.
Type: string.
sync.9.password Joplin Server password.
Type: string.
sync.maxConcurrentConnections Max concurrent connections.
Type: int.
Default: 5
locale Language.
Type: Enum.
Possible values: ar (Arabic (73%)), eu (Basque (19%)), nb_NO
(Bokmål, Norwegian; Norwegian Bokmål (Norge, Noreg) (72%)), bs_BA
(Bosnian (Bosna i Hercegovina) (47%)), bg_BG (Bulgarian
(България) (37%)), ca (Catalan; Valencian (79%)), hr_HR (Croatian
(Hrvatska) (84%)), cs_CZ (Czech (Česká republika) (81%)), da_DK
(Dansk (Danmark) (99%)), de_DE (Deutsch (Deutschland) (99%)),
et_EE (Eesti Keel (Eesti) (36%)), en_GB (English (United Kingdom)
(100%)), en_US (English (United States of America) (100%)), es_ES
(Español (España) (80%)), eo (Esperanto (21%)), fi_FI (Finnish
(Suomi) (81%)), fr_FR (Français (France) (99%)), gl_ES (Galician
(España) (24%)), id_ID (Indonesian (Indonesia) (97%)), it_IT
(Italiano (Italia) (84%)), hu_HU (Magyar (Magyarország) (63%)),
nl_BE (Nederlands (België, Belgique, Belgien) (64%)), nl_NL
(Nederlands (Nederland) (84%)), fa (Persian (99%)), pl_PL (Polski
(Polska) (87%)), pt_BR (Português (Brasil) (99%)), pt_PT
(Português (Portugal) (60%)), ro (Română (87%)), sl_SI (Slovenian
(Slovenija) (66%)), sv (Svenska (97%)), th_TH (Thai (ประเทศไทย)
(30%)), vi (Tiếng Việt (64%)), tr_TR (Türkçe (Türkiye) (99%)),
uk_UA (Ukrainian (Україна) (82%)), el_GR (Ελληνικά (Ελλάδα)
(87%)), ru_RU (Русский (Россия) (97%)), sr_RS (српски језик
(Србија) (53%)), zh_CN (中文 (简体) (99%)), zh_TW (中文 (繁體) (87%)),
ja_JP (日本語 (日本) (85%)), ko (한국어 (92%)).
Default: "en_GB"
dateFormat Date format.
Type: Enum.
Possible values: DD/MM/YYYY (30/01/2017), DD/MM/YY (30/01/17),
MM/DD/YYYY (01/30/2017), MM/DD/YY (01/30/17), YYYY-MM-DD
(2017-01-30), DD.MM.YYYY (30.01.2017), YYYY.MM.DD (2017.01.30),
YYMMDD (170130), YYYY/MM/DD (2017/01/30).
Default: "DD/MM/YYYY"
timeFormat Time format.
Type: Enum.
Possible values: HH:mm (20:30), h:mm A (8:30 PM), HH.mm (20.30).
Default: "HH:mm"
uncompletedTodosOnTop Uncompleted to-dos on top.
Type: bool.
Default: true
showCompletedTodos Show completed to-dos.
Type: bool.
Default: true
notes.sortOrder.field Sort notes by.
Type: Enum.
Possible values: user_updated_time (Updated date),
user_created_time (Created date), title (Title), order (Custom
order), todo_due (Due date), todo_completed (Completion date).
Default: "user_updated_time"
notes.sortOrder.reverse Reverse sort order.
Type: bool.
Default: true
folders.sortOrder.field Sort notebooks by.
Type: Enum.
Possible values: title (Title), last_note_user_updated_time
(Updated date).
Default: "title"
folders.sortOrder.reverse Reverse sort order.
Type: bool.
Default: false
trackLocation Save geo-location with notes.
Type: bool.
Default: true
sync.interval Synchronization interval.
Type: Enum.
Possible values: 0 (Disabled), 300 (5 minutes), 600 (10 minutes),
1800 (30 minutes), 3600 (1 hour), 43200 (12 hours), 86400 (24
hours).
Default: 300
editor Text editor command.
The editor command (may include arguments) that will be used to
open a note. If none is provided it will try to auto-detect the
default editor.
Type: string.
net.customCertificates Custom TLS certificates.
Comma-separated list of paths to directories to load the
certificates from, or path to individual cert files. For example:
/my/cert_dir, /other/custom.pem. Note that if you make changes to
the TLS settings, you must save your changes before clicking on
"Check synchronization configuration".
Type: string.
net.ignoreTlsErrors Ignore TLS certificate errors.
Type: bool.
Default: false
net.proxyEnabled Proxy enabled.
Type: bool.
Default: false
net.proxyUrl Proxy URL.
For example "http://my.proxy.com:80"
Type: string.
net.proxyTimeout Proxy timeout (seconds).
Type: int.
Default: 1
sync.wipeOutFailSafe Fail-safe.
Fail-safe: Do not wipe out local data when sync target is empty
(often the result of a misconfiguration or bug)
Type: bool.
Default: true
revisionService.enabled Enable note history.
Type: bool.
Default: true
revisionService.ttlDays Keep note history for.
Type: int.
Default: 90
layout.folderList.factor Notebook list growth factor.
The factor property sets how the item will grow or shrink to fit
the available space in its container with respect to the other
items. Thus an item with a factor of 2 will take twice as much
space as an item with a factor of 1.Restart app to see changes.
Type: int.
Default: 1
layout.noteList.factor Note list growth factor.
The factor property sets how the item will grow or shrink to fit
the available space in its container with respect to the other
items. Thus an item with a factor of 2 will take twice as much
space as an item with a factor of 1.Restart app to see changes.
Type: int.
Default: 1
layout.note.factor Note area growth factor.
The factor property sets how the item will grow or shrink to fit
the available space in its container with respect to the other
items. Thus an item with a factor of 2 will take twice as much
space as an item with a factor of 1.Restart app to see changes.
Type: int.
Default: 2
trash.autoDeletionEnabled Automatically delete notes in the trash after a number of days.
Type: bool.
Default: true
trash.ttlDays Keep notes in the trash for.
Type: int.
Default: 90
root@localhost:~#
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment