coscmd文档v1.8

功能说明

使用 COSCMD 工具，用户可通过简单的命令行指令实现对对象（Object）的批量上传、下载、删除等操作。

使用限制

适用于 COS V4、V5 版本；

使用环境

系统环境

Windows 或 Linux 系统

软件依赖

Python 2.6/2.7
并装有最新版本的pip

安装及配置

环境安装与配置详细操作请参考 Python 安装与配置。

下载与安装

手动安装
下载链接：GitHub 链接
在该项目根目录下使用如下命令安装

python setup.py install

pip 安装
执行pip命令进行安装：

pip install coscmd

安装成功之后，用户可以通过-v或者--version命令查看当前的版本信息。如下图所示：
[图片上传失败...(image-8f816e-1513760626623)]

pip 更新
下执行pip命令进行更新：

pip install coscmd -U

注意不论是在linux还是windows环境下，都可以通过以上的方法安装或更新

使用方法

查看 help

用户可通过-h或--help命令来查看工具的 help 信息。

coscmd -h  //查看当面版本信息

help 信息如下图所示：
[图片上传失败...(image-6c5ae4-1513760626623)]
除此之外，用户还可以在每个命令后（不加参数）输入-h查看该命令的具体用法，例如：

coscmd upload -h  //查看 upload 命令使用方法

配置参数

COSCMD 工具在使用前需要进行参数配置。用户可以直接编辑~/.cos.conf文件，也可以通过如下命令来配置：

coscmd config -a <access_id> -s <secret_key> -u <appid> -b <bucketname> -r <region> [-m <max_thread>] [-p <parts_size>]

上述示例中使用"<>"的字段为必选参数，使用"[]"的字段为可选参数。其中：

名称	描述	有效值
secret_id	必选参数，APPID 对应的密钥 ID，可从控制台获取，参考基本概念。	字符串
secret_key	必选参数，APPID 对应的密钥 Key，可从控制台获取，参考基本概念。	字符串
appid	必选参数，需要进行操作的 APPID，可从控制台获取，参考基本概念。	数字
bucketname	必选参数，指定的存储桶名称，需要提前在控制台建立，参考创建存储桶。	字符串
region	必选参数，存储桶所在地域。有效值：cn-south（华南）、 cn-north（华北）、cn-east（华东）、cn-southwest（西南）、sg（新加坡），参考可用地域。	字符串
max_thread	可选参数，多线程上传时的最大线程数（默认为 5），有效值：1~10	数字
parts_size	可选参数，分块上传的单块大小（单位为 M，默认为 1M），有效值：1~10	数字

配置完成之后的.cos.conf文件内容示例如下所示：

 [common]
secret_id = AChT4ThiXAbpBDEFGhT4ThiXAbpHIJK
secret_key = WE54wreefvds3462refgwewerewr
appid = 1234567890
bucket = ABC
region = cn-south
max_thread = 5
part_size = 1

上传文件或文件夹

上传文件命令如下：

coscmd upload <localpath> <cospath>  //命令格式
coscmd upload /home/aaa/123.txt bbb/123.txt  //操作示例

上传文件夹命令如下：

coscmd upload -r <localpath> <cospath>  //命令格式
coscmd upload -r /home/aaa/ bbb/  //操作示例

请将 "<>" 中的参数替换为您需要上传的本地文件路径（localpath），以及 COS 上存储的路径（cospath）。
注意：

上传文件时需要将cos上的路径包括文件(夹)的名字补全(参考例子)。
COSCMD 支持大文件断点上传功能。当分片上传大文件失败时，重新上传该文件只会上传失败的分块，而不会从头开始（请保证重新上传的文件的目录以及内容和上传的目录保持一致）。

下载文件或文件夹

下载文件命令如下：

coscmd download <cospath> <localpath>  //命令格式
coscmd download bbb/123.txt /home/aaa/111.txt  //操作示例

如下下载文件夹命令如下：

coscmd download-r <cospath> <localpath> //命令格式
coscmd download -r /home/aaa/ bbb/  //操作示例

请将 "<>" 中的参数替换为您需要下载的 COS 上文件的路径（cospath），以及本地存储路径（localpath）。
注意：

若本地存在同名文件，则会下载失败。使用 -f 参数覆盖本地文件

删除文件或文件夹

删除文件命令如下：

coscmd delete <cospath>  //命令格式
coscmd delete bbb/123.txt  //操作示例

如下删除文件夹命令如下：

coscmd delete -r <cospath>  //命令格式
coscmd delete -r bbb/  //操作示例

请将"<>"中的参数替换为您需要删除的 COS 上文件的路径（cospath）。工具会提示用户是否确认进行删除操作。
注意：

批量删除需要输入确定，使用 -f 参数跳过确认

打印文件列表

打印命令如下：

coscmd list <cospath>  //命令格式
coscmd list -a //操作示例
coscmd list bbb/123.txt  -r -n 10 //操作示例

请将"<>"中的参数替换为您需要打印文件列表的 COS 上文件的路径（cospath）。

使用-a打印全部文件
使用 -r 递归打印
使用 -n num 设置打印数量的最大值

注意：

<cospath>为空默认打印当前Bucket根目录

显示文件信息

命令如下：

coscmd info <cospath>  //命令格式
coscmd info bbb/123.txt //操作示例

请将"<>"中的参数替换为您需要显示的 COS 上文件的路径（cospath）。

获取带签名的下载url

命令如下：

coscmd sigurl<cospath>  //命令格式
coscmd signurl bbb/123.txt //操作示例
coscmd signurl bbb/123.txt -t 100//操作示例

请将"<>"中的参数替换为您需要获取下载url的 COS 上文件的路径（cospath）。

使用 -t time 设置打印签名的有效时间(单位为秒)

debug 模式执行命令

在各命令前加上-d或者-debug，在命令执行的过程中，会显示详细的操作信息。示例如下：

//显示upload的详细操作信息
coscmd -d upload <localpath> <cospath>  //命令格式
coscmd -d upload /home/aaa/123.txt bbb/123.txt  //操作示例

设置访问控制(ACL)

命令如下：

使用如下命令设置bucket的访问控制：

coscmd putbucketacl [--grant-read GRANT_READ]  [--grant-write GRANT_WRITE] [--grant-full-control GRANT_FULL_CONTROL] //命令格式
coscmd putbucketacl --grant-read 12345678,12345678/11111 --grant-write anyone --grant-full-control 12345678/22222 //操作示例

使用如下命令设置object的访问控制：

coscmd putbucketacl [--grant-read GRANT_READ] [--grant-write GRANT_WRITE] [--grant-full-control GRANT_FULL_CONTROL] <cospath> //命令格式
coscmd putbucketacl --grant-read 12345678,12345678/11111 --grant-write anyone --grant-full-control 12345678/22222 aaa/aaa.txt //操作示例

获取访问控制(ACL)

coscmd getbucketacl //命令格式
coscmd getbucketacl //操作示例