对象存储
文档捉虫大赛：人工智能与机器学习专题> HOT
文档中心 > 对象存储 > 工具指南 > COSCLI 工具（公测） > 下载与安装配置

下载与安装配置

最近更新时间：2023-09-20 20:15:21

我的收藏

本页目录：

COSCLI 工具提供 Windows、Mac、Linux 操作系统的二进制包，通过简单的安装和配置后即可使用。

步骤一：下载 COSCLI 工具

您可以根据业务场景选择下载 COSCLI 工具的地址。如果您的服务器在国内，推荐使用国内站点下载地址。
国内站点下载地址
Github下载地址（推荐国外站点使用）
Windows
Windows
Mac
Mac
Mac-m1
Mac-m1
Linux
Linux
您也可以通过命令行，获取国内站点 MAC 和 Linux 环境下的 COSCLI 工具文件：
Mac：wget https://cosbrowser.cloud.tencent.com/software/coscli/coscli-mac
Mac-m1：wget https://cosbrowser.cloud.tencent.com/software/coscli/coscli-mac-m1
Linux：wget https://cosbrowser.cloud.tencent.com/software/coscli/coscli-linux
说明：
Github上当前版本号为 v0.15.0-beta，如需获取工具的最新版本、历史版本和更新日志，请前往 release 进行查看。

步骤二：安装 COSCLI 工具

Windows

1. 将已下载的 Windows 版本 COSCLI 工具，移动至 C:\\Users\\<用户名> 目录下。
2. 将 coscli-windows.exe 重命名为 coscli.exe。
3. 按 win+r 键打开 运行 程序。
4. 在对话框中，输入 cmd，按 Enter 打开命令行窗口。
5. 在命令行窗口中，输入 coscli --version，若打印出以下信息则代表安装成功：
说明
在 Windows 系统下，在不同的命令行客户端中使用 COSCLI 的方式可能略有不同，若输入 coscli [command] 后 COSCLI 无法正常工作，请尝试 ./coscli [command] 的格式。
coscli version v0.15.0-beta

Mac

1. 运行以下命令，重命名 Mac 版本 COSCLI 文件：
mv coscli-mac coscli
2. 运行以下命令修改文件执行权限：
chmod 755 coscli
3. 在命令行中输入 ./coscli --version，若打印出以下信息则代表安装成功：
coscli version v0.15.0-beta
说明
在 Mac 系统下使用 COSCLI 时，若弹出 无法打开 “coscli”，因为无法验证开发者 的提示，可以前往 设置 > 安全性与隐私 > 通用 中选择 仍要打开 coscli，之后即可正常使用 COSCLI。

Linux

1. 运行以下命令，重命名 Linux 版本 COSCLI 文件：
mv coscli-linux coscli
2. 运行以下命令修改文件执行权限：
chmod 755 coscli
3. 在命令行窗口中输入 ./coscli --version，若打印出以下信息则代表安装成功：
coscli version v0.15.0-beta

步骤三：配置COSCLI 工具

注意
建议用户通过 临时密钥 使用工具，通过临时授权的方式进一步提高工具使用的安全性。申请临时密钥时，请遵循 最小权限指引原则，防止泄露目标存储桶或对象之外的资源。
如果您一定要使用永久密钥，建议遵循 最小权限指引原则 对永久密钥的权限范围进行限制。
首次使用 COSCLI 时，用户需要初始化配置文件。配置文件包含以下两部分内容：
1. 授权 COSCLI 访问您的腾讯云账号，需要您配置密钥 ID、密钥 Key、临时密钥 Token。
2. 为常用桶添加别名，需要您配置常用桶名称、桶所在地域信息、桶别名。配置常用桶信息后，用户可以使用别名进行桶操作，无需再填写桶名称和地域信息。添加多个常用桶配置后，还可以更便捷的进行跨桶或跨域的操作。如果无需配置常用桶信息，可以按 Enter 跳过。
初次使用时，COSCLI 会自动调用 ./coscli config init 在 ~/.cos.yaml 位置生成配置文件，您可以在命令行交互式的完成配置。后续您也可以使用 ./coscli config init 命令在其他位置为 COSCLI 交互式地生成配置文件。您可以使用./coscli config show来查看配置文件的所在位置和配置参数信息。
配置文件中各配置项的说明如下：
配置项
说明
Secret ID
密钥 ID，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 子账号访问密钥管理。
Secret Key
密钥 Key，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 子账号访问密钥管理。
Session Token
临时密钥 token，当使用临时密钥时需要配置，若不使用可以直接按 Enter 跳过。 关于临时密钥的更多信息，详见 使用临时密钥访问 COS。
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 支持的地域列表可参见 地域与访问域名。
如果存储桶开启了全球加速，可配置全球加速域名，全球加速域名格式为<BucketName-APPID>.cos.accelerate.myqcloud.com，内网全球加速域名格式为<BucketName-APPID>.cos-internal.accelerate.tencentcos.cn。
Bucket Alias
存储桶别名，配置后可以在使用时用 BucketAlias 代替 BucketName-APPID，减少所需输入的命令长度，如果不配置此项，BucketAlias 的值是 BucketName-APPID 的值。
OFS Bucket
元数据加速桶标记，用于标识该桶是否开启 元数据加速 功能。目前元数据加速功能为公测功能，需要 联系我们 申请使用。公测期间暂不收费，您可以关注您的 站内信 或者 计费概述，了解最新的计费动态。
在初次配置时，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 均为加密后的字符串。

中国站