docs: comma delimited options in pin remote --help
This adds clarification suggested in https://github.com/ipfs/go-ipfs/pull/7823#pullrequestreview-577889138
Marcin Rataj committed
Jan 28, 2021 at 17:23 UTC
3bca93787a7af6e0ad0f4b6866d698f1c614cf79
1 file changed
+8
-1
core/commands/pin/remotepin.go
+8
-1
@@ -112,7 +112,14 @@ after remote service confirms 'queued' status, add the '--background' flag:
112
113
$ ipfs pin remote add --service=mysrv --name=mypin --background bafkqaaa
114
115
-Status of background pin requests can be inspected with the 'ls' command:
115
+Status of background pin requests can be inspected with the 'ls' command.
116
+
117
+To list all pins for the CID across all statuses:
118
+
119
+ $ ipfs pin remote ls --service=mysrv --cid=bafkqaaa --status=queued \
120
+ --status=pinning --status=pinned --status=failed
121
+
122
+NOTE: a comma-separated notation is supported in CLI for convenience:
123
124
$ ipfs pin remote ls --service=mysrv --cid=bafkqaaa --status=queued,pinning,pinned,failed
125