|
| 1 | +## Simple Export |
| 2 | + |
| 3 | +### All user queries have the prompt: |
| 4 | +`Enter a keyword search, label search or --all' to convert Keep notes to md or '--x' to exit:` |
| 5 | + |
| 6 | +#### User query and export active notes (no notes will be overwritten) |
| 7 | +`python kim.py` |
| 8 | + |
| 9 | +#### User query and export only archived notes |
| 10 | +`python kim.py -a` |
| 11 | + |
| 12 | +#### User query and export active notes and overwrite existing markdown notes |
| 13 | +`python kim.py -o` |
| 14 | + |
| 15 | +#### User query and export active notes that were edited after Jun 15, 2023 |
| 16 | +`python kim.py -ed "> 2023-06-15"` |
| 17 | + |
| 18 | +#### Export all active notes in batch without user prompts |
| 19 | +`python kim.py -b --all` |
| 20 | + |
| 21 | +#### Export only notes with the label #science in batch without user prompts |
| 22 | +`python kim.py -b "#science"` |
| 23 | + |
| 24 | +#### Export all active notes in batch with create dates after Jan 1, 2023 |
| 25 | +`python kim.py -cd "> 2023-01-01" -b --all` |
| 26 | + |
| 27 | +#### Export all active notes in batch and skip over notes already exported |
| 28 | +`python kim.py -s -b --all` |
| 29 | + |
| 30 | + |
| 31 | +## Complex Export |
| 32 | +#### Export all active notes in batch formatted to Joplin front matter headers, and move them to archive after export with edit dates after May 14, 2024 |
| 33 | +`python kim.py -j -m -ed "> 2023-05-14" -b --all` |
| 34 | + |
| 35 | +#### Export all active notes with the label #computer in batch using the first note line as the markdown file title if the title is missing (50 chars max), preserve Logseq namespaces and format Logseq bullets, and overwriting any existing notes |
| 36 | +`python kim.py -c -l -o -b "#computer"` |
| 37 | + |
| 38 | +#### Export all active notes in batch preserving Keep labels with spaces and special characters, skipping over existing notes, moving them to archive after export |
| 39 | +`python kim.py -p -s -m -b --all` |
| 40 | + |
| 41 | +#### Export all archived notes in batch, overwriting existing notes and modifying Keep note-to-note markdown links to wikilinks |
| 42 | +`python kim.py -a -o -w -b --all` |
| 43 | + |
| 44 | +### List of options |
| 45 | +``` |
| 46 | +Options: |
| 47 | + -r Will reset and not use the local keep access token in your system's keyring |
| 48 | + -o Overwrite any existing markdown files with the same name |
| 49 | + -a Search and export only archived notes |
| 50 | + -p Preserve keep labels with spaces and special characters |
| 51 | + -s Skip over any existing notes with the same title |
| 52 | + -c Use starting content within note body instead of create date for md filename |
| 53 | + -l Prepend paragraphs with Logseq style bullets and preserve namespaces |
| 54 | + -j Prepend notes with Joplin front matter tags and dates |
| 55 | + -m Move any exported Keep notes to Archive |
| 56 | + -w Convert pre-formatted markdown note-to-note links to wikilinks |
| 57 | + -i Import notes from markdown files WARNING - EXPERIMENTAL!! |
| 58 | + -cd, --cd TEXT Export notes before or after the create date - < or >|YYYY-MM-DD |
| 59 | + -ed, --ed TEXT Export notes before or after the edit date - < or >|YYYY-MM-DD |
| 60 | + -b, --search-term TEXT Run in batch mode with a specific Keep search term |
| 61 | + -t, --master-token TEXT Log in using master keep token |
| 62 | + --help Show this message and exit. |
| 63 | +``` |
0 commit comments