joplin 1.2.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/Makefile +1 -0
- data/bin/jp +917 -73
- data/lib/joplin/version.rb +1 -1
- data/readme.md +66 -0
- metadata +1 -1
data/lib/joplin/version.rb
CHANGED
data/readme.md
CHANGED
|
@@ -45,6 +45,72 @@ You can specify the id of the notebook
|
|
|
45
45
|
|
|
46
46
|
## CLI
|
|
47
47
|
|
|
48
|
+
### jp
|
|
49
|
+
|
|
50
|
+
A general purpose Joplin utility that interacts directly with the Joplin database. It uses the `JOPLIN_DATA_DIR` environment variable to locate the database.
|
|
51
|
+
|
|
52
|
+
```text
|
|
53
|
+
Usage:
|
|
54
|
+
jp COMMAND [ARGS]
|
|
55
|
+
|
|
56
|
+
Commands:
|
|
57
|
+
jp add NOTEBOOK [BODY...] # Add a note
|
|
58
|
+
jp bkup # Backup the database
|
|
59
|
+
jp cal [DATE] # Show calendar
|
|
60
|
+
jp cat TARGET... # Display note content
|
|
61
|
+
jp edit TARGET # Edit a note or tag stack
|
|
62
|
+
jp export PATH # Export notes as Markdown with front matter
|
|
63
|
+
jp flashback [DATE] # Show notes from this day in previous years
|
|
64
|
+
jp help [COMMAND] # Describe available commands or one specific command
|
|
65
|
+
jp info # Show JP and Joplin profile information
|
|
66
|
+
jp init SUBCOMMAND # Print shell integration code
|
|
67
|
+
jp journal [today|yesterday|YYYY-MM-DD] [TEXT...] # Append to a daily journal note; omit DATE for today
|
|
68
|
+
jp log [DATE] [SLICE] # Show log
|
|
69
|
+
jp ls [TARGET] # List notebooks, notes, or tags
|
|
70
|
+
jp mv SOURCE DESTINATION # Rename a notebook or tag
|
|
71
|
+
jp random # Display a random note
|
|
72
|
+
jp rm TARGET # Move a note or notebook to Trash, or recursively remove a tag
|
|
73
|
+
jp search QUERY # Search notes for text
|
|
74
|
+
jp settings SUBCOMMAND # Manage settings
|
|
75
|
+
jp test # Run tests
|
|
76
|
+
jp trash SUBCOMMAND # Manage trashed notes and notebooks
|
|
77
|
+
jp tree # Print a tree of all available commands
|
|
78
|
+
jp version # Show version
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
`jp export PATH` preserves the notebook hierarchy, writes note metadata as YAML
|
|
82
|
+
front matter, copies referenced resources, and rewrites resource links. Pass
|
|
83
|
+
`--no-resources` (`-N`) to export Markdown without copying resources.
|
|
84
|
+
|
|
85
|
+
On macOS, new notes and journal entries include the current coordinates when
|
|
86
|
+
`CoreLocationCLI` is installed and location access is allowed. Set
|
|
87
|
+
`CORE_LOCATION_CLI` to an executable path to use a non-default installation, or
|
|
88
|
+
to an empty string to disable location lookup.
|
|
89
|
+
|
|
90
|
+
Triggered reminders for incomplete to-dos are shown before normal command
|
|
91
|
+
output. Raw note output and shell completion do not include these warnings.
|
|
92
|
+
|
|
93
|
+
### joplin
|
|
94
|
+
|
|
95
|
+
Commands that interact with Joplin via the API.
|
|
96
|
+
|
|
97
|
+
```text
|
|
98
|
+
Commands:
|
|
99
|
+
joplin build # build a note from a note containing references
|
|
100
|
+
joplin clean # clean unused resources
|
|
101
|
+
joplin epub # build a note from a note (help build), write the note, and create an epub
|
|
102
|
+
joplin help [COMMAND] # Describe available commands or one specific command
|
|
103
|
+
joplin nb2n # concate all notes in a notebook to one note. Possible PDF export
|
|
104
|
+
joplin resource # get resource for note
|
|
105
|
+
joplin stats # statistics on joplin data
|
|
106
|
+
joplin tree # Print a tree of all available commands
|
|
107
|
+
joplin version # get version of program
|
|
108
|
+
joplin write # write a note
|
|
109
|
+
|
|
110
|
+
Options:
|
|
111
|
+
[--token=TOKEN]
|
|
112
|
+
```
|
|
113
|
+
|
|
48
114
|
### joplin nb2n --token <yourtoken> 'notebook name'
|
|
49
115
|
|
|
50
116
|
Will take a notebook and concatenate all notes into one for easy export to PDF
|