Skip to content

proof-of-concept implementation of FUSE for Earthstar

Notifications You must be signed in to change notification settings

fwip/earthstar-fuse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

earthstar-fuse

A proof-of-concept implementation of FUSE on top of Earthstar.

This means that you can take a database that backs an Earthstar workspace and interact with it as if it were just a whole bunch of files in folders.

Caveats

  1. This is pre-alpha quality software.
  2. This has only been tested on 1 machine for about 10 minutes.
  3. A couple times when developing it, it locked up my mac and I had to reboot.
  4. Performance is quite bad.
  5. It might corrupt your data, please back it up first.

Only tested on a Macbook Pro running Catalina. Might work on Linux, almost definitely doesn't work on Windows.

Roadmap

  • Viewing documents as files
  • Writing documents
  • Tests
  • Performance

Quickstart

In the below steps, /path/to/mnt/ is the full path to a directory of your choice. This directory should exist and also be empty.

  1. Clone the repo
  2. npm install
  3. npm src/index.js /path/to/mnt/ my.sqlite author-keypair.json
  4. In a new window, do ls /path/to/mnt/

If you get a mysterious error, file an issue and/or check out these troubleshooting steps to enable FUSE.

About

proof-of-concept implementation of FUSE for Earthstar

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published