feat: add chaincode command doc

bestchains · Jun 27, 2023 · 0bcf051 · 0bcf051
1 parent 50ad46a
commit 0bcf051
Showing 1 changed file with 86 additions and 0 deletions.
diff --git a/docs/tools/cli.md b/docs/tools/cli.md
@@ -618,3 +618,89 @@ Usage:
   chaincodebuild-fd76h   67d
   ```
 
+### 获取 chaincode
+
+获取指定 channel 的 chaincode 列表，支持查看一个或多个 chaincode 详细信息。通过 `-h` 查看命令定义。
+`--channel` 是必选参数，除非指定了若干 chaincode 名称。
+`--id` 是可选参数，chaincode 的 id。
+`--version` 是可选参数，chaincode 的 version。
+
+支持 `kubectl get` 的展示性参数，例如 `-o json`、`-o yaml` 等。
+
+```shell
+➜  bc-cli git:(main) ✗ ./bc-cli get chaincode -h
+Get a list of the chaincode installed on a channel
+
+Usage:
+  bc-cli get chaincode [NAME] [flags]
+```
+
+1. 获取指定 channel 下的 chaincode 列表
+
+  ```shell
+  ➜  bc-cli git:(main) ✗ ./bc-cli get chaincode --channel channel-z56ar
+  NAME              AGE
+  chaincode-3bdbf   69d
+  chaincode-79t9d   70d
+  chaincode-9x3y4   69d
+  chaincode-d632u   69d
+  chaincode-g6vhr   69d
+  chaincode-l10c3   69d
+  chaincode-r1iu2   61d
+
+  ```
+
+2. 获取指定 channel 下的某个 id 的 chaincode 列表
+
+  ```shell
+  ➜  bc-cli git:(main) ✗ ./bc-cli get chaincode --channel channel-z56ar --id acl
+  NAME              AGE
+  chaincode-d632u   69d
+  chaincode-g6vhr   69d
+  chaincode-l10c3   69d
+  ```
+
+3. 获取指定 channel 下的某个 id 和 version 的 chaincode 列表
+
+  ```shell
+  ➜  bc-cli git:(main) ✗ ./bc-cli get chaincode --channel channel-z56ar --id acl --version v0.0.1
+  NAME              AGE
+  chaincode-d632u   69d
+  chaincode-g6vhr   69d
+  chaincode-l10c3   69d
+  ```
+
+4. 获取指定若干名称的 chaincode
+
+  ```shell
+  ➜  bc-cli git:(main) ✗ ./bc-cli get chaincode chaincode-r1iu2 chaincode-l10c3
+  NAME              AGE
+  chaincode-r1iu2   61d
+  chaincode-l10c3   69d
+  ```
+
+5. 以 `yaml` 方式展示 chaincode 详细信息
+
+  ```shell
+  ➜  bc-cli git:(main) ✗ ./bc-cli get chaincode chaincode-r1iu2 -o yaml
+  apiVersion: ibp.com/v1beta1
+  kind: Chaincode
+  metadata:
+    creationTimestamp: "2023-04-26T08:38:11Z"
+    generation: 2
+    labels:
+      bestchains.chaincode.channel: channel-z56ar
+      bestchains.chaincode.id: depository
+      bestchains.chaincode.version: v0.0.2
+      bestchians.chaincode.endorsementpolicy: epolicy-bj4xw
+    name: chaincode-r1iu2
+    resourceVersion: "673796295"
+    uid: 3fb44b49-274f-4d39-9df4-20a204ac7aef
+  spec:
+    channel: channel-z56ar
+    endorsePolicyRef:
+      name: epolicy-bj4xw
+    externalBuilder: chaincodebuild-m1m8z
+    id: depository
+    # ...
+  ```