coscmd 1.8.0

simple command for cos

COSCMD使用文档
========
|Build-Status|

依赖
--------

操作系统为linux, python版本为2.7，系统安装有pip（可通过yum/apt来安装，包名为python-pip）。


安装
--------

在该项目根目录下执行如下命令安装:

.. code::

pip install coscmd


使用方法
--------

工具的使用前需要配置！你可以直接编辑~/.cos.conf，也可以通过下面的命令来配置。


配置参数
^^^^^^^^

.. code::

coscmd config -a yoursecretid -s yoursecretkey -u appid -b bucketname -r region -m max_thread -p parts_size


请将参数替换为您的真实id/key/appid/bucket和园区代号,园区(region)为ap-guangzhou或者其他园区。

max_thread为多线程上传时的最大线程数(默认为5)

parts_size为分块上传的单块大小(单位为M)(默认为1M)

或者直接修改~/.cos.conf文件，下面是一个例子

.. code::

[common]
secret_id = AChT4ThiXAbpBDEFGhT4ThiXAbpHIJK
secret_key = WE54wreefvds3462refgwewerewr
appid = 1251000577
bucket = ABC
region = ap-guangzhou
max_thread = 5
part_size = 1



上传文件(夹)
^^^^^^^^

使用如下命令上传文件：

.. code::

coscmd upload localpath cospath

请将参数替换为您所需要的本地文件路径(localpath)，以及cos上存储的路径(cospath)。

支持大文件断点上传为功能。

当分片上传大文件失败时，重新上传该文件只会上传失败的分块，而不会从头开始(请保证重新上传的文件绝对目录以及内容和上传的目录不要改变)

使用-r上传文件夹。


下载文件(夹)
^^^^^^^^

使用如下命令上传文件：

.. code::

coscmd download cospath localpath

请将参数替换为您所需要下载的cos上文件的路径(cospath)，以及需要的本地存储路径(localpath)。

使用-r下载文件夹。


删除文件(夹)
^^^^^^^^

使用如下命令删除文件：

.. code::

coscmd delete cospath

请将参数替换为您所需要删除的cos上文件的路径(cospath)。

使用-r删除文件夹。


打印bucket下文件列表
^^^^^^^^

使用如下命令删除文件：

.. code::

coscmd list <cospath>

请将参数替换为您所需要删除的cos上文件的路径(cospath)。

使用-r递归打印。

使用-a打印所有文件，默认打印100个。

使用-n num设置打印文件的数量。

若cospath为空则打印根目录下的文件列表


获取文件信息
^^^^^^^^

使用如下命令删除文件：

.. code::

coscmd info <cospath>

请将参数替换为您所需要删除的cos上文件的路径(cospath)。

访问控制(ACL)相关
^^^^^^^^^
使用如下命令设置bucket的访问控制：

.. code::

coscmd putbucketacl [--grant-read GRANT_READ]
[--grant-write GRANT_WRITE]
[--grant-full-control GRANT_FULL_CONTROL]

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

.. code::

coscmd putbucketacl [--grant-read GRANT_READ]
[--grant-write GRANT_WRITE]
[--grant-full-control GRANT_FULL_CONTROL]
<cospath>

--grant-read代表读的权限。

--grant-write代表写的权限。

--grant-full-control代表读写的权限。

GRANT_READ/GRANT_WRITE/GRANT_FILL_CONTORL代表被赋权的帐号。

若赋权根帐号，使用rootid的形式；

若赋权子账户，使用rootid/subid的形式；

若需要对所有人赋权，使用anyone的形式。

同时赋权的多个帐号用逗号(,)隔开。

请将参数替换为您所需要删除的cos上文件的路径(cospath)。

详细用法请见下面的示例。

使用如下命令获取bucket的访问控制：

.. code::

coscmd getbucketacl

使用如下命令获取object的访问控制：

.. code::

coscmd putbucketacl <cospath>

请将参数替换为您所需要删除的cos上文件的路径(cospath)。

详细用法请见下面的示例。

简单示例
^^^^^^^^

.. code::

设置属性
coscmd config -a SECRET_ID -s SECRET_KEY -u 1252448703 -b uploadtest -r ap-guangzhou -m 10 -p 5

上传文件
coscmd upload bbb/A.txt aaa/B.txt

上传文件夹
coscmd upload -r aaa/folder1 bbb/folder2

下载文件
coscmd download aaa/B.txt bbb/A.txt

下载文件夹
coscmd download aaa/folder1 bbb/folder2

删除文件
coscmd delete aaa/B.txt

删除文件夹
coscmd delete -r bbb/folder2

打印文件列表
coscmd list -n 20
coscmd list -a -r aa/folder1/

获取文件信息
coscmd info aaa/aaa.txt

设置bucket的ACL
coscmd putbucketacl --grant-read 12345678,12345678/11111 --grant-write anyone --grant-full-control 12345678/22222
这里给予帐户12345678，12345678下面的子账户11111读的权限，
给所有人写的权限，
给12345678下面的子账户22222所有的权限

设置object的ACL
coscmd putbucketacl --grant-read 12345678,12345678/11111 --grant-write anyone --grant-full-control 12345678/22222 aaa/aaa.txt

获取bucket的ACL
coscmd getbucketacl

获取object的ACL
coscmd getobjectacl aaa/aaa.txt

注意事项
^^^^^^^^
配置项建议：

#. max_thread <= 10
#. parts_size <= 10

.. |Build-Status| image:: https://travis-ci.org/tencentyun/coscmd.svg?branch=master
  :target: https://travis-ci.org/tencentyun/coscmd