API Reference

Module overview

protonfs.argv	Make flags position-independent on the protonfs command line.
protonfs.batching	Helpers for grouping and chunking file lists ahead of bulk remote operations.
protonfs.cli	The protonfs command-line entry point: the Click command tree.
protonfs.config	Layered configuration for a protonfs repo.
protonfs.context	Assembles the per-invocation context CLI commands operate against.
protonfs.diff	Three-way diff between local scan, index, and remote listing.
protonfs.drive	The proton-drive CLI wrapper: DriveClient plus its result/error types.
protonfs.ignore	gitignore-syntax filtering of which repo files protonfs syncs.
protonfs.index	The local sync manifest: .protonfs/index.json and its schema-versioned store.
protonfs.install	Self-diagnosing installer for the proton-drive prebuilt binary (Tier 3).
protonfs.lfs	git-LFS awareness: detect LFS tracking and the tiny pointer-stub files it leaves.
protonfs.localscan	Walks the local filesystem to produce the "local" side of a three-way diff.
protonfs.locking	Advisory repo lock so two concurrent protonfs processes cannot interleave index writes.
protonfs.logs	Wire the console + event-log handlers and build the process Reporter.
protonfs.migrations	Versioned repo-state migrations (#67).
protonfs.refreshstate	Resumable-refresh state: the persisted BFS frontier for protonfs refresh (#33 item 2).
protonfs.reporting	Curated, level-gated progress narration for the CLI (the Reporter layer).
protonfs.secretservice	Make the freedesktop Secret Service reachable on a headless Linux host.

Class hierarchies

Drive error tree — every Drive failure mode subclasses DriveError, so a single except DriveError at the CLI boundary catches them all:

CLI group/command classes — the epilog mix-in and the position-independent flag group layered onto Click’s base classes:

Full module documentation

• protonfs
  • protonfs package