Skip to content

grrclone · Reference

API reference

The logic of grrclone lives in two Swift packages that build and test without Xcode. Their API reference is generated with DocC from the v0.9.5 release:

  • GrrCloneCore: the connection lifecycle (start the daemon, serve, mount, unmount, reconcile after a crash), the registry of mounts grrclone made, mount health, the stored connections, and the rclone config password and encryption.
  • RcloneRC: the client for rclone’s remote-control API over a unix socket, with serving, config, providers, bandwidth limits and deadlines for calls that can’t be cancelled.

These are the packages’ public and internal declarations as the code documents them; the app target and grrclonectl aren’t included. How it works on mlaify.io describes how the parts fit together.