docmount

Mount an ATProto collection as a local FUSE filesystem and translate OXA records to MyST markdown on the fly.

What it does

• logs into an ATProto PDS
• lists records from a collection, defaulting to pub.oxa.document
• exposes each record as a *.myst.md file
• reads and writes through @nandithebull/myst-oxa
• saves changes back to the repo when files are closed

Install

npm install @nandithebull/docmount

Requirements

• Linux with FUSE support
• a PDS / ATProto service
• an account identifier and app password

On NixOS, run inside a shell that provides fuse / libfuse.so.2.

CLI usage

docmount /path/to/mount \
  --service https://bsky.social \
  --identifier handle.example.com \
  --password "$BLUESKY_APP_PASSWORD"

You can also use environment variables:

• DOCMOUNT_MOUNT
• ATPROTO_SERVICE or PDS_URL
• ATPROTO_IDENTIFIER or ATPROTO_HANDLE
• BLUESKY_APP_PASSWORD or ATPROTO_PASSWORD
• ATPROTO_COLLECTION
• DOCMOUNT_EXTENSION
• DOCMOUNT_TTL_MS

Defaults

• collection: pub.oxa.document
• file extension: .myst.md
• cache TTL: 5000 ms

Library API

import { AtprotoOxaClient, DocMountFS, parseConfig } from "@nandithebull/docmount";

Exports:

• AtprotoOxaClient
• DocMountFS
• parseConfig
• helpText

Build

bun run build

License

MIT