34 lines
1.6 KiB
Markdown
34 lines
1.6 KiB
Markdown
|
# `ipfs-cluster-ctl`
|
||
|
|
||
|
> IPFS cluster management tool
|
||
|
|
||
|
`ipfs-cluster-ctl` is the client application to manage the cluster nodes and perform actions. `ipfs-cluster-ctl` uses the HTTP API provided by the nodes and it is completely separate from the cluster service.
|
||
|
|
||
|
|
||
|
### Usage
|
||
|
|
||
|
Usage information can be obtained by running:
|
||
|
|
||
|
```
|
||
|
$ ipfs-cluster-ctl --help
|
||
|
```
|
||
|
|
||
|
You can also obtain command-specific help with `ipfs-cluster-ctl help [cmd]`. The (`--host`) can be used to talk to any remote cluster peer (`localhost` is used by default). In summary, it works as follows:
|
||
|
|
||
|
|
||
|
```
|
||
|
$ ipfs-cluster-ctl id # show cluster peer and ipfs daemon information
|
||
|
$ ipfs-cluster-ctl peers ls # list cluster peers
|
||
|
$ ipfs-cluster-ctl peers add /ip4/1.2.3.4/tcp/1234/<peerid> # add a new cluster peer
|
||
|
$ ipfs-cluster-ctl peers rm <peerid> # remove a cluster peer
|
||
|
$ ipfs-cluster-ctl pin add Qma4Lid2T1F68E3Xa3CpE6vVJDLwxXLD8RfiB9g1Tmqp58 # pins a CID in the cluster
|
||
|
$ ipfs-cluster-ctl pin rm Qma4Lid2T1F68E3Xa3CpE6vVJDLwxXLD8RfiB9g1Tmqp58 # unpins a CID from the cluster
|
||
|
$ ipfs-cluster-ctl status # display tracked CIDs information
|
||
|
$ ipfs-cluster-ctl sync Qma4Lid2T1F68E3Xa3CpE6vVJDLwxXLD8RfiB9g1Tmqp58 # sync information from the IPFS daemon
|
||
|
$ ipfs-cluster-ctl recover Qma4Lid2T1F68E3Xa3CpE6vVJDLwxXLD8RfiB9g1Tmqp58 # attempt to re-pin/unpin CIDs in error state
|
||
|
```
|
||
|
|
||
|
### Debugging
|
||
|
|
||
|
`ipfs-cluster-ctl` takes a `--debug` flag which allows to inspect request paths and raw response bodies.
|