/usr/bin/ipfs-cluster-ctl

NAME:
   ipfs-cluster-ctl - CLI for IPFS Cluster

USAGE:
   ipfs-cluster-ctl [global options] command [command options] [arguments...]

VERSION:
   1.1.6

DESCRIPTION:

ipfs-cluster-ctl is a tool to manage IPFS Cluster nodes.

Use "ipfs-cluster-ctl help" to list all available commands and
"ipfs-cluster-ctl help <command>" to get usage information for a
specific one.

ipfs-cluster-ctl uses the IPFS Cluster API to perform requests and
display responses in a user-readable format. The location of the IPFS
Cluster server is assumed to be /ip4/127.0.0.1/tcp/9094, but can be configured
with the --host option. If several multiaddresses are specified
(comma-separated), requests will be sent to the first one and fail-over
over to the others. This also works for dns-based addresses which resolve
to multiple values.

To use the secure libp2p-http API endpoint, use "--host" with
the full cluster libp2p listener address, including the "/p2p/<peerID>"
part, or a /dnsaddr that resolves to it. Provide the cluster secret with
--secret as needed.

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


COMMANDS:
   id       Retrieve peer information
   peers    List and manage IPFS Cluster peers
   add      Add a file or directory to ipfs and pin it in the cluster
   pin      Pin and unpin and list items in IPFS Cluster
   status   Retrieve the status of tracked items
   recover  Recover tracked items in error state
   version  Retrieve cluster version
   health   Cluster monitoring information
   ipfs     Manage IPFS daemon
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --host value, -l value         API endpoint multiaddresses (comma-separated) (default: "/ip4/127.0.0.1/tcp/9094")
   --secret value                 cluster secret (32 byte pnet-key) as needed. Only when using the LibP2P endpoint
   --https, -s                    use https to connect to the API
   --no-check-certificate         do not verify server TLS certificate. only valid with --https flag
   --encoding value, --enc value  output format encoding [text, json] (default: "text")
   --timeout value, -t value      number of seconds to wait before timing out a request (default: 0)
   --debug, -d                    set debug log level
   --basic-auth value             <username>[:<password>] specify BasicAuth credentials for server that
requires authorization. implies --https, which you can disable with --force-http [$CLUSTER_CREDENTIALS]
   --force-http, -f  force HTTP. only valid when using BasicAuth
   --help, -h        show help
   --version, -v     print the version