adjust share-related docs (#419)

qiniu · Nov 1, 2024 · 3ce84c7 · 3ce84c7
1 parent 8afdceb
commit 3ce84c7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/docs/create-share.md b/docs/create-share.md
@@ -1,5 +1,5 @@
 # 简介
-`create-share` 命令为需要分享的目录创建授权链接。
+`create-share` 命令为需要分享的目录或前缀创建授权链接。
 
 # 格式
 ```
@@ -21,7 +21,7 @@ $ qshell create-share --doc
 
 # 参数
 - Bucket: 空间名称【必选】
-- Prefix: 前缀【必选】
+- Prefix: 前缀，注意如果要分享云存储内的目录，则必须以 `/` 结尾【必选】
 
 # 选项
 - --extract-code: 提取码，只能包含六位大小写字母或者数字，如果不填写，将会自动生成。【可选】

diff --git a/docs/share-cp.md b/docs/share-cp.md
@@ -1,5 +1,5 @@
 # 简介
-`share-cp` 命令用来从目录分享链接内下载单个文件或按指定前缀批量下载文件。
+`share-cp` 命令用来从目录分享链接内下载单个文件或按目录批量下载文件。
 
 # 格式
 ```
@@ -24,12 +24,13 @@ $ qshell share-cp --doc
 
 # 选项
 - --extract-code: 提取码，只能包含六位大小写字母或者数字，如果不填写，且 `Link` 不是通过 `create-share` 命令的 `--output` 选项输出的文件路径，将会用交互模式提示输入。【可选】
-- --from: 下载共享目录内的子目录或是子文件，如果不填写，将列举被分享的目录。【可选】
-- --to: 下载目标路径。【必填】
+- --from: 指定被分享的目录或文件，如果不填写，将列举被分享的根目录。需要注意如果希望下载目录，路径必须以 `/` 结尾。【可选】
+- --to: 下载目标的目录路径。【必填】
+- -r/--recursive: 批量下载目录内所有子目录和文件
 
 # 示例
 ```
-$ qshell share-cp 'http://portal.qiniu.com/kodo-shares/verify?id=AGQEKDRxBBjbGmsKduQS9oFx59rz&token=qhtbC5YmDCO-WiPriuoCG_t4hZ1LboSOtRYSJXo_%3A9uJY8FiNrKjNrt4MpBx547jlgwr8aes15z5i8VY6l5SU6ga2IKWDBSGTv1jo-rOocklE7QqApzG6okJktZ36umLoqv9x1kuo5fNmgasLXowyTuHIM3kXsaV_DoXmvQsGr5ol6j4RtrmLcKdtXhpkGH8MfSjEgRV91Bx_Q_mSwpJ1028p8yZCSad_QOu_kSPxzeLZmWlUpAtO2oEXdbMTBxhTCH_3awCgqkgoogi0FQGP4zHxeFr0n3vj69DpmWqe6DiYbYLivCuU0kOF5Khv4I6-w6vjjdY' --to=shared/
+$ qshell share-cp -r 'http://portal.qiniu.com/kodo-shares/verify?id=AGQEKDRxBBjbGmsKduQS9oFx59rz&token=qhtbC5YmDCO-WiPriuoCG_t4hZ1LboSOtRYSJXo_%3A9uJY8FiNrKjNrt4MpBx547jlgwr8aes15z5i8VY6l5SU6ga2IKWDBSGTv1jo-rOocklE7QqApzG6okJktZ36umLoqv9x1kuo5fNmgasLXowyTuHIM3kXsaV_DoXmvQsGr5ol6j4RtrmLcKdtXhpkGH8MfSjEgRV91Bx_Q_mSwpJ1028p8yZCSad_QOu_kSPxzeLZmWlUpAtO2oEXdbMTBxhTCH_3awCgqkgoogi0FQGP4zHxeFr0n3vj69DpmWqe6DiYbYLivCuU0kOF5Khv4I6-w6vjjdY' --to=shared/
 Input Extract Code:
 wp7gqc