- sfs-web (cmd/sfs-web, internal/webapp): read-only Obsidian-style web UI serving a local folder (default) or an sfs remote; markdown rendering with [[wikilinks]], task lists and tables, file downloads with ETags, per-file provenance from the journals; added to goreleaser builds - .sfs project file (internal/config): per-folder volume/remote/include settings that travel with the folder, win over the global registry, and never sync; daemon picks up edits live - .sfsignore + include lists (internal/syncer): gitignore-style selective sync with ! re-includes, applied symmetrically in scan and materialize; newly ignored files stop syncing without being deleted anywhere - Claude Code plugin (plugin/, .claude-plugin/): sfs skill, /sfs:mount and /sfs:status commands, turn-boundary sync hooks (blocking pull on prompt, async push on stop); installable via the repo's marketplace manifest - CLAUDE.md and .claude project settings for Claude Code development Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HHEUaYfFHhmDvqLYw74Ehz
2.0 KiB
description: Mount a folder as a synced sfs volume — one command sets up the sync daemon, the .sfs project config, and (via this plugin's hooks) automatic sync at every turn boundary argument-hint: [folder] [remote e.g. s3://bucket/prefix]
Mount a folder as a synced sfs volume. Arguments: $ARGUMENTS (optional folder, optional remote URL).
Follow these steps:
-
Check sfs is installed: run
command -v sfs. If missing, offer to install it (brew install runbear-io/tap/sfs, orgo install github.com/runbear-io/sfs/cmd/sfs@latest) and wait for the user's choice before installing. -
Determine the folder: first argument if given, otherwise the current directory. If the folder already contains a
.sfsfile, the volume and remote are already configured — just runsfs mnt <folder>and skip step 3. -
Determine the remote: second argument if given. If not given, ask the user which backend they want:
s3://bucket/prefix— Amazon S3 or any S3-compatible store (R2/MinIO viaAWS_ENDPOINT_URL)gs://bucket/prefix— Google Cloud Storagefile:///abs/path— a plain shared directory (NAS, external drive)- none — local-only for now (
sfs remote setcan add one later)
-
Mount: run
sfs mnt <folder> [--remote <url>]. This registers the background sync daemon and writes the folder's settings to<folder>/.sfs. -
Verify: run
sfs status <folder>and show the result. If the remote errored, consult the sfs skill's troubleshooting table (credentials are the usual cause). -
Tell the user what's now active (briefly):
- the daemon syncs continuously (every few seconds);
- this plugin's hooks also sync at every turn boundary — a blocking pull when they send a message, an async push when the turn ends — so Claude always works on fresh files;
.sfsignorein the folder root excludes files (gitignore-style); an"include"list in.sfsnarrows what syncs;sfs logshows who changed what,sfs umntstops syncing.