roam-to-csv

Convert a Roam Research EDN export into CSV format.

Given ./backup.edn, creates ./backup.csv with pages and blocks.

$ ./roam-to-csv ./backup.edn && cat backup.csv
uid,title,parent,string,order,create-time
06-28-2021,"June 28th, 2021",,,,2021-06-28T13:08:13.256Z
FsF3FaIio,,LZiyTHIGa,five,0,2021-06-28T13:08:25.145Z
KVVSsviKY,,06-28-2021,one,0,2021-06-28T13:08:15.015Z
xNUTmfMSW,,FsF3FaIio,six,0,2021-06-28T13:08:26.471Z
LZiyTHIGa,,06-28-2021,four,1,2021-06-28T13:08:23.257Z
tPEEzk_7o,,KVVSsviKY,two,0,2021-06-28T13:08:16.514Z
59okYh_ss,,KVVSsviKY,three,1,2021-06-28T13:08:18.451Z

You can also use it to format a Roam export for readability:

$ ./roam-to-csv --pretty-print ./backup.edn && cat backup.pp.edn
#datascript/DB {:schema
                {:create/user
                 {:db/valueType :db.type/ref,
                  :db/cardinality :db.cardinality/one},
                 :plugin/id {:db/unique :db.unique/identity},
                 :node/subpages
                 {:db/valueType :db.type/ref,
                  :db/cardinality :db.cardinality/many},
# ... lots of lines ...
                 [10 :block/string "six" 536870946]
                 [10 :block/uid "xNUTmfMSW" 536870941]
                 [10 :create/time 1624885706471 536870941]
                 [10 :create/user 3 536870941]
                 [10 :edit/time 1624885709593 536870946]
                 [10 :edit/user 3 536870941]]}

You can write your own Datalog queries to output as CSV. Please see Datomic's Query Reference for advanced usage.

# Output only :block/uid and :block/string
$ ./roam-to-csv ./backup.edn --query "[:find ?uid ?string :where [?b :block/uid ?uid] [?b :block/string ?string]]" && cat backup.csv
uid,string
FsF3FaIio,five
KVVSsviKY,one
xNUTmfMSW,six
LZiyTHIGa,four
59okYh_ss,three
tPEEzk_7o,two

# Output all known attributes

$ ./roam-to-csv ./backup.edn --query "[:find (distinct ?attr) :where [?e ?attr]]" && cat backup.csv
(distinct ?attr)
#{:create/user :block/string :version/nonce :create/time :node/title :edit/user :user/display-name :block/children :log/id :block/uid :block/open :user/uid :edit/time :block/parents :block/order :user/photo-url :block/page :version/id :version/upgraded-nonce}

All options:

$ ./roam-to-csv --help
Convert a Roam Research EDN export into CSV format.
Given ./backup.edn, creates ./backup.csv with pages and blocks.

Usage:
  roam-to-csv ./backup.edn

Options:
  -e, --extra         Include extra information: user, edit, open, path, refs.
  -q, --query QUERY   Use a custom Datalog query to create the CSV.
  -p, --pretty-print  Pretty print the EDN export only.
  -c, --convert       Convert an input csv to another format [athens.transit roam.json]
  -h, --help          Show this message.

Installation

You can find binaries for Linux, MacOS, and Windows in https://github.com/filipesilva/roam-to-csv/releases.

Download the archive for your respective OS, unpack it, and inside you will have a roam-to-csv binary you can run.

You can also build from source and run that code, or any modifications you add, by following the instructions below.

Development

This project is based on jayfu and so setup instructions are pretty much copy paste.

Prerequisites

• Download GraalVM. Just download it to your Downloads folder and unzip the archive. No further installation required. This tutorial is based on version 21.1.0 JDK11.

• Set the GRAALVM_HOME environment variable. E.g.:

  export GRAALVM_HOME=/Users/borkdude/Downloads/graalvm-ce-java11-21.1.0/Contents/Home

• To run with Clojure or Java, you will need to have a Java 8 or 11 installation available. You can also use the downloaded GraalVM for this.

• Install babashka (0.4.1 or higher).

Windows

Always use cmd.exe for executing GraalVM compilation, do not use PowerShell.

On Windows, install Visual Studio 2017 or 2019 and in cmd.exe load:

"C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"

This will set the right environment variables for GraalVM.

After this you should be able to run bb native-image.

Tasks

To see all available tasks in this project, run bb tasks:

$ bb tasks
The following tasks are available:

run-main     Run main
uberjar      Builds uberjar
run-uber     Run uberjar
graalvm      Checks GRAALVM_HOME env var
native-image Builds native image

Run

To run this example using Clojure, run:

$ bb run-main --help
Convert a Roam Research EDN export into CSV format.
Given ./backup.edn, creates ./backup.csv with pages and blocks.

Usage:
  roam-to-csv ./backup.edn

Options:
  -q, --query QUERY   Use a custom Datalog query to create the CSV.
  -p, --pretty-print  Pretty print the EDN export only.
  -h, --help          Show this message.

$ bb run-main ./backup.edn && cat backup.csv
uid,title,parent,string,order,create-time
06-28-2021,"June 28th, 2021",,,,2021-06-28T13:08:13.256Z
FsF3FaIio,,LZiyTHIGa,five,0,2021-06-28T13:08:25.145Z
KVVSsviKY,,06-28-2021,one,0,2021-06-28T13:08:15.015Z
xNUTmfMSW,,FsF3FaIio,six,0,2021-06-28T13:08:26.471Z
LZiyTHIGa,,06-28-2021,four,1,2021-06-28T13:08:23.257Z
tPEEzk_7o,,KVVSsviKY,two,0,2021-06-28T13:08:16.514Z
59okYh_ss,,KVVSsviKY,three,1,2021-06-28T13:08:18.451Z

Build

To build the native image, run:

$ bb native-image

This should produce a binary called roam-to-csv.

License

Roam-to-CSV is open source software licensed as MIT.