logseq-migration

Download and use local copies of assets in logseq after importing a file from roam.

NB: Users have reported problems running this on Windows. I have been unable to reproduce the problem, so I cannot fixit. The software should run on any model of a Raspberry Pi so Windows users with a Pi could install and run the software there.

Roam stores the assets (images, pdfs, mp4 files etc.) in the cloud.

While logseq makes it easy for you to import a roam json export, your assets will remain in the cloud.

That worries me, because

2. I want to store all the data that I own in my local file system.
3. I want to be able to view my pages even if I am not connected to the Internet.
4. The assets could disappear if roam research ceased trading or changed its policy about closed accounts.

So I adapted the code from here to suit logseq instead of Obsidian, wrote some minimal tests and refactored the code.

It's currently beta software

It's had limited testing, but it worked for me on a graph with about 1800 nodes.

Once installed, you can run the code each time you want to process a recently imported roam graph.

Since the program messes with the markdown in your pages (in order to make asset links local),

back up your graph before you run this code!

The application is easy to install and run. You'll find instructions below.

Installation

Install required software

Python 3

The code is written in Python, and you will need an installed copy of Python3.8 or later.

If you don't already have a suitable copy of Python installed, you'll find installation instructions here.

Under Windows, it appears that you must install Python system-wide (with script wrappers) and ask for Python to be added to your PATH.

pip3

pip is Python's package manager. You'll need pip3, the version that supports Python3.

This is normally installed with Python3. If it isn't for some reason you can follow these instructions.

Install the application

run pip3 install logseq-migration

Run the application

run localise_assets <vault_dir>

where vault_dir is the directory in which your logseq graph lives.

You'll see version information printed, and the word done when the migration is complete

The migrator will create a logfile called migration.log. By default, this will only log the start and end of the migration, with any errors.

If you wish to see detailed debug information, run localise_assets <vault_dir> 1

The code is idempotent. In other words, if you run it two or more times, nothing should change after the first run.

Let me know how you get on, and please raise an issue if there are problems, or you want to suggest new features.

There's a roadmap and a project journal. If you're interested in contributing, get in touch. Help is always welcome!

I'm @rareblog on Twitter.