Skip to content

Latest commit

 

History

History
155 lines (120 loc) · 16.2 KB

readme.md

File metadata and controls

155 lines (120 loc) · 16.2 KB

jimmy

Free your notes by converting them to Markdown.

💾 Download: Linux | Windows | MacOS GitHub Downloads (all assets, all releases)

If there is an issue at download or execution, please take a look at the step-by-step instructions.

📘 For detailed information, take a look at the Documentation.

⭐ If Jimmy is useful for you, feel free to star it on Github.

build lint tests

Features

  • ✅ Several supported input formats
  • ✅ Markdown + Frontmatter output
    • Compatible with any text editor
    • Can be imported to Joplin/Obsidian/...
    • Preserves resources, tags and note links when possible
  • ✅ Offline
  • ✅ Open Source
  • ✅ Cross-platform
  • ✅ Standalone (no Docker, Python or NodeJS installation required)
  • ❎ No AI

Supported Apps

Export data from your app and convert it to Markdown. For details, click on the links.
A
Anki
Anytype
B
Bear
C
Cacher
CherryTree
Clipto
ColorNote
D
Day One
Drafts
Dynalist
E
Evernote
F
Facebook
FuseBase, Nimbus Note
G
Google Docs
Google Keep
J
Joplin
jrnl
N
Notion
O
Obsidian
Q
QOwnNotes
R
RedNotebook
S
Simplenote
Standard Notes
Synology Note Station
T
Telegram		 Textbundle, Textpack
Tiddlywiki
Tomboy-ng, Gnote
Turtl
W
Wordpress
Z
Zettelkasten
Zim
Zoho Notebook

Supported Formats

Import a single file or a folder (recursively). Files of these formats will be converted to Markdown. The formats can be mixed. For example you can import a folder with two Asciidoc files and one docx file. The conversion result will be a folder with three Markdown files and the corresponding attachments.
A
Asciidoc
C
CSV
D DocBook
docx
E eml
EPUB
F
Fountain
H
HTML
J
Jupyter Notebook
M
Markdown
MediaWiki
O
ODT
OPML
R reStructuredText RTF
T txt2tags

General Usage

flowchart LR
    A[App 1] -->|Backup| M
    B[App 2] -->|Export| M
    C[...] --> M
    D[Filesystem] --> M
    M(ZIP archive/JSON/Folder) --> N
    N{jimmy} --> O(Markdown + Frontmatter)
    O -->|Import| P[Joplin]
    O -->|Import| Q[Obsidian]
    O --> R[...]
    O --> S[Editor, e. g. VSCode]
Loading
  1. Export/backup notes from your note application
  2. Run jimmy, which converts your notes to Markdown
  3. Import the result to Joplin/Obsidian or use any editor to view the notes

After conversion, the notes should be available in a folder named like YYYY-MM-DD HH:MM:SS - Import. Make sure your data is converted properly ❗

What is converted (in most cases)?

  • Note content
  • Tags / Labels
  • Images / Resources / Attachments
  • External links and internal note links

Step-by-step Instructions

Step Linux / MacOS Example Windows Example
Export your notes to your download folder /home/user/Downloads/Export.zip C:\Users\user\Downloads\Export.zip
Download Jimmy to your download folder [1] /home/user/Downloads/jimmy-cli-linux C:\Users\user\Downloads\jimmy-cli-windows.exe
Open a terminal Linux / MacOS instructions Windows instructions
Change to the download folder cd /home/user/Downloads/ cd C:\Users\user\Downloads\
Make Jimmy executable chmod +x jimmy-cli-linux -
Do the conversion [2] [3] ./jimmy-cli-linux Export.zip --format notion jimmy-cli-windows.exe Export.zip --format notion
Check the output folder /home/user/Downloads/20250226T200101Z - Jimmy Import from notion C:\Users\user\Downloads\20250226T200101Z - Jimmy Import from notion

[1] On Windows: If jimmy is flagged as virus, please report the false positive to your antivirus vendor. As workaround you can try an older version of jimmy.

[2] On MacOS: If there is the error message zsh: bad CPU type in executable, please use this executable. It is supported by Intel chips.

[3] On MacOS: If there is the error message "jimmy-cli-darwin-arm64" cannot be opened because the developer cannot be verified, please authorize jimmy at System Settings > Privacy & Security > Security > Open Anyway. See also the Apple support guide.

Demo

Example commands for the Linux CLI app:

# import a single file supported by pandoc
jimmy-cli-linux libre_office_document.odt

# import all files in a folder
jimmy-cli-linux path/to/folder

# import a Google Keep export
jimmy-cli-linux takeout-20240401T160516Z-001.zip --format google_keep

This is an example of a successful conversion:

$ jimmy-cli-linux .cache/google_keep/takeout-20240401T160516Z-001.zip --format google_keep --frontmatter joplin
[09/19/24 15:15:34] INFO     Importing notes from ".cache/google_keep/takeout-20240401T160516Z-001.zip"
                    INFO     Start parsing
                    INFO     Finished parsing: 1 notebooks, 3 notes, 1 resources, 3 tags
                    INFO     Start filtering
                    INFO     Finished filtering: 1 notebooks, 3 notes, 1 resources, 3 tags
                    INFO     Start writing to file system
                    INFO     Converted notes successfully to Markdown: "20240919T131534Z - Jimmy Import from google_keep". Please verify that everything was converted correctly.
                    INFO     Feel free to open an issue on Github, write a message at the Joplin forum or an email.

Notebooks  100%|████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00]
Notes      100%|████████████████████████████████████████████████████████████████████| 3/3 [00:00<00:00]
Resources  100%|████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00]
Tags       100%|████████████████████████████████████████████████████████████████████| 3/3 [00:00<00:00]

Similar Projects