一、步骤一:下载 COSCLI 工具
你可以根据业务场景选择下载 COSCLI 工具的地址。如果你的服务器在中国,推荐使用中国站点下载地址(此处链接的工具版本均为最新版本,如需使用旧版本,可访问 release 获取历史版本)。
| 中国站点下载地址 | GitHub 下载地址(推荐海外用户使用) | SHA256校验 |
| Windows-386 | Windows-386 | 84ef2c95290cda7a38ad543f3d105f3d9ae2cc8a9d18cfd4ceb09d4212978765 |
| Windows-amd64 | Windows-amd64 | 705350f15ba90d9c0043122205b79c938e2993d36610fa82fbc3cc9012108300 |
| macOS-amd64 | macOS-amd64 | 49a784987010de548b000ba509df28d600dfde3d530b445edb84bc7900d84c73 |
| macOS-arm64 | macOS-arm64 | cf99d4546e4f2962739c6d25f6e0e7f0b49c94854e2dae237de38d0e8d27c263 |
| Linux-386 | Linux-386 | 3ab30f1d067cd46154f33412006211dc912404a09c08f360968ae84b517d7dcb |
| Linux-amd64 | Linux-amd64 | a07de5ba2800147a700ed29036b0c76a4229088cee68e1682d0eae19b638a915 |
| Linux-arm | Linux-arm | bc209844683e6f271862152b20ea99a05b03e75d216fc6b4980d17e6edee97c5 |
| Linux-arm64 | Linux-arm64 | 5cac5ca3c093f080d6733f4c698c0bdbebdb7b30a6b50835b85de1727b8b6923 |
你也可以通过命令行,获取中国站点 macOS 和 Linux 环境下的 COSCLI 工具文件:
·macOS-amd64:wget https://cosbrowser.cloud.tencent.com/software/coscli/coscli-darwin-amd64
·macOS-arm64:wget https://cosbrowser.cloud.tencent.com/software/coscli/coscli-darwin-arm64
·Linux-386:wget https://cosbrowser.cloud.tencent.com/software/coscli/coscli-linux-386
·Linux-amd64:wget https://cosbrowser.cloud.tencent.com/software/coscli/coscli-linux-amd64
·Linux-arm:wget https://cosbrowser.cloud.tencent.com/software/coscli/coscli-linux-arm
·Linux-arm64:wget https://cosbrowser.cloud.tencent.com/software/coscli/coscli-linux-arm64
注意:说明:
注意:GitHub 上当前版本为 v1.0.9,如需获取工具的最新版本、历史版本和更新日志,请前往 release 进行查看。
二、Windows
1. 以 windows-amd64版本为例,将已下载的 Windows 版本 COSCLI 工具,移动至 C:\\Users\\<用户名> 目录下。
2. 将 coscli-windows-amd64.exe 重命名为 coscli.exe。
3. 按 win+r 键打开 运行 程序。
4. 在对话框中,输入 cmd,按 Enter 打开命令行窗口。
5. 在命令行窗口中,输入以下命令。
coscli –version
若输出 coscli version v1.0.9,则安装成功。
注意:说明:
注意:在 Windows 系统下,在不同的命令行客户端中使用 COSCLI 的方式可能略有不同,若输入 coscli [command] 后 COSCLI 无法正常工作,请尝试 ./coscli [command] 的格式。
三、macOS
1. 以 macOS-amd64版本为例,运行以下命令,重命名 macOS 版本 COSCLI 文件。
mv coscli-darwin-amd64 coscli
2. 运行以下命令修改文件执行权限。
chmod 755 coscli
3. 在命令行中输入以下命令。
./coscli –version
若输出 coscli version v1.0.9,则安装成功。
注意:说明:
注意:在 macOS 系统下使用 COSCLI 时,若弹出无法打开 “coscli”,因为无法验证开发者的提示,可以前往设置 > 安全性与隐私 > 通用中选择仍要打开 coscli,之后即可正常使用 COSCLI。
四、Linux
1. 以 Linux-amd64版本为例,运行以下命令,重命名 Linux 版本 COSCLI 文件。
mv coscli-linux-amd64 coscli
2. 运行以下命令修改文件执行权限。
chmod 755 coscli
3. 在命令行窗口中输入以下命令。
./coscli –version
若输出 coscli version v1.0.9,则安装成功。
五、步骤三:配置 COSCLI 工具
首次使用 COSCLI 时,用户需要初始化配置文件。配置文件包含以下两部分内容:
·授权 COSCLI 访问你的腾讯云账号,需要你配置密钥 ID、密钥 Key、临时密钥 Token。
·为常用桶添加别名,需要你配置常用桶名称、桶所在地域信息、桶别名。配置常用桶信息后,用户可以使用别名进行桶操作,无需再填写桶名称和地域信息。添加多个常用桶配置后,还可以更便捷的进行跨桶或跨域的操作。如果无需配置常用桶信息,可以按 Enter 跳过。
以 Linux 系统为例,初次使用时,COSCLI 会自动调用./coscli config init 在~/.cos.yaml 位置生成配置文件,你可以在命令行交互式的完成配置。后续你也可以使用./coscli config init 命令在其他位置为 COSCLI 交互式地生成配置文件。你可以使用./coscli config show 来查看配置文件的所在位置和配置参数信息。
配置文件中各配置项的说明如下:
| 配置项 | 是否必填 | 说明 |
| Secret ID | 是 | 密钥 ID,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取请参见 子账号访问密钥管理。注意:通过初始化或命令配置的 Secret ID 会加密存储,如需手动修改配置文件,需设置 Disable Encryption 参数关闭密钥加密。 |
| Secret Key | 是 | 密钥 Key,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取请参见 子账号访问密钥管理。注意:通过初始化或命令配置的 Secret Key 会加密存储,如需手动修改配置文件,需设置 Disable Encryption 参数关闭密钥加密。 |
| Session Token | 否 | 临时密钥 token,当使用临时密钥时需要配置,若不使用可以直接按 Enter 跳过。 关于临时密钥的更多信息,请参见 使用临时密钥访问 COS。注意:通过初始化或命令配置的 Session Token 会加密存储,如需手动修改配置文件,需设置 Disable Encryption 参数关闭密钥加密。 |
| Mode | 否 | 设置身份模式,支持枚举值 SecretKey 和 CvmRole。可以为空,空值默认为SecretKey,表示使用密钥请求 COS。当 Mode 为 CvmRole 时,表示使用 管理实例角色 请求 COS。 |
| Cvm Role Name | 否 | 设置 CVM 角色实例名称,详情请参见 管理实例角色。 |
| protocol | 否 | 网络传输协议,默认为 https。如需更改为 http,可直接进入配置文件进行修改即可。 |
| APPID | 是 | APPID 是你在成功申请腾讯云账户后所得到的账号,由系统自动分配,可从 账号信息 中获取。一个存储桶的全称由 Bucket Name 和 APPID 这两个元素组成,格式为 <BucketName-APPID>,详情请参见 存储桶命名规范。 |
| Bucket Name | 是 | 存储桶名称,和 APPID 一起构成存储桶全称,格式为 <BucketName-APPID>,详情请参见 存储桶命名规范。 |
| Bucket Endpoint | 是 | 存储桶所在地域的域名,默认域名格式为 cos.<region>.myqcloud.com,其中 <region> 代表存储桶地域,例如 ap-guangzhou、ap-beijing 等,COS 支持的地域列表请参见 地域与访问域名。如果存储桶开启了全球加速,可配置全球加速域名。例如,全球加速域名配置为cos.accelerate.myqcloud.com;内网全球加速域名配置为cos-internal.accelerate.tencentcos.cn。 |
| Bucket Alias | 否 | 存储桶别名,配置后可以在使用时用 BucketAlias 代替 BucketName-APPID,减少所需输入的命令长度,如果不配置此项,BucketAlias 的值是 BucketName-APPID 的值。 |
| OFS Bucket | 否 | 元数据加速桶标记,用于标识该桶是否开启 元数据加速 功能。 |
| CloseAutoSwitchHost | 否 | 设置是否关闭自动切换备份域名。可选值 true | false,可以为空。若不设置或值为 false,则会进行备份域名切换。若设置为 true,则不进行备份域名切换。 |
| DisableEncryption | 否 | 设置是否关闭密钥加密。可选值 true | false,可以为空。若不设置或值为 false ,则会加密配置文件中的密钥相关信息。若设置为 true,则不加密配置文件中的密钥相关信息。 |
| DisableAutoFetchBucketType | 否 | 设置是否关闭自动获取桶类型。可选值 true | false,可以为空。若不设置或值为 false ,则工具会自动获取桶类型,需要授权cos:HeadBucket权限。如果设置为 true,工具将不会自动识别桶类型,而是优先根据参数 –bucket-type 来确定桶类型。若未设置该参数,则依据配置文件中桶信息的 ofs 参数确定桶类型(true 表示为 OFS 桶,false 表示为 COS 桶)。如果配置文件中未包含桶信息,则默认使用 COS 桶类型。 |
在初次配置时,COSCLI 只会要求你配置一个存储桶的信息,如果你希望配置多个存储桶,你后续可以使用./coscli config add 命令添加存储桶配置。如你需要修改配置文件,或获取更多有关配置文件的操作,请参见 config 命令 或使用./coscli config –help 命令来快速查看和配置文件相关的指令。
在正式开始使用指令之前,你可以使用./coscli –help 命令来快速查看 COSCLI 的使用方法。
六、其他配置方法
除了使用./coscli config init 交互式地生成配置文件外,你也可以直接手动编写 COSCLI 的配置文件。COSCLI 的配置文件格式是 YAML 格式,配置文件示例如下:
cos: base: secretid: XXXXXXXXXXXXXXX secretkey: XXXXXXXXXXXXXXXXX sessiontoken: "" protocol: https buckets: – name: examplebucket1-1250000000 alias: bucket1 region: ap-shanghai endpoint: cos.ap-shanghai.myqcloud.com ofs: false – name: examplebucket2-1250000000 alias: bucket2 region: ap-guangzhou endpoint: cos.ap-guangzhou.myqcloud.com ofs: false – name: examplebucket3-1250000000 alias: bucket3 region: ap-chengdu endpoint: cos.ap-chengdu.myqcloud.com ofs: false
注意:COSCLI 默认从 ~/.cos.yaml 处读取配置项,若用户想要使用自定义的配置文件,请在命令后使用 -c (–config-path)选项。配置文件存储的 secretid/secretkey/sessiontoken 均为加密后的字符串。