/usr/bin/ipfs-cluster-follow

NAME:
   ipfs-cluster-follow - IPFS Cluster Follower

USAGE:
   ipfs-cluster-follow [global options] <clusterName> [subcommand]...

VERSION:
   1.1.6+git2182e887ef378f906455784396f1011df968822c

DESCRIPTION:

   ipfs-cluster-follow helps running IPFS Cluster follower peers.

   Follower peers subscribe to a Cluster controlled by a set of "trusted
   peers". They collaborate in pinning items as dictated by the trusted peers and
   do not have the power to make Cluster-wide modifications to the pinset.

   Follower peers cannot access information nor trigger actions in other peers.

   ipfs-cluster-follow can be used to follow different clusters by launching it
   with different options. Each Cluster has an identity, a configuration
   and a datastore associated to it, which are kept under
   "~/.ipfs-cluster-follow/<cluster_name>".

   For feedback, bug reports or any additional information, visit
   https://github.com/ipfs-cluster/ipfs-cluster.


   EXAMPLES:

   List configured follower peers:

   $ ipfs-cluster-follow

   Display information for a follower peer:

   $ ipfs-cluster-follow <clusterName> info

   Initialize a follower peer:

   $ ipfs-cluster-follow <clusterName> init <example.url>

   Launch a follower peer (will stay running):

   $ ipfs-cluster-follow <clusterName> run

   List items in the pinset for a given cluster:

   $ ipfs-cluster-follow <clusterName> list

   Getting help and usage info:

   $ ipfs-cluster-follow --help
   $ ipfs-cluster-follow <clusterName> --help
   $ ipfs-cluster-follow <clusterName> info --help
   $ ipfs-cluster-follow <clusterName> init --help
   $ ipfs-cluster-follow <clusterName> run --help
   $ ipfs-cluster-follow <clusterName> list --help



COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --config FOLDER  path to the followers configuration and data FOLDER (default: "/tmp/.ipfs-cluster-follow") [$IPFS_CLUSTER_PATH]
   --help, -h       show help
   --version, -v    print the version