tencent cloud

All product documents
Cloud Object Storage
DocumentationCloud Object StorageUser ToolsCOSCLI (Beta)Download and Installation Configuration
Download and Installation Configuration
Download PDF
Last updated: 2024-11-28 16:32:41
Download and Installation Configuration
Last updated: 2024-11-28 16:32:41
Download PDF
COSCLI provides binary packages for Windows, macOS, and Linux, which can be used after simple installation and configuration.

Step 1: Download the COSCLI tool

You can choose the download address for the COSCLI tool based on your business scenario. If your server is in China, it's recommended to use the Domestic Site Download Address.
Domestic Site Download Address
GitHub Download Address (for international sites)
SHA256 Checksum
9e5f9b9bf31159d88b8909aa6ce0ec9e1299559ba5d18597dedeae3904399631
3ad02fe9d4fa093846c81b288ecd63317e88812832efd2be47759ac140351e92
Mac-amd64
Mac-amd64
085f25241c182978e82bbfccb37e012bbc53c363b0abae0beafc35f729258f0c
Mac-arm64
Mac-arm64
327da2360844a1a8375262f1edbfac09121de91e11f6481f960b75cb763eae05
Linux-386
Linux-386
45c60a7aae8d3512fb29caaad5d37e7a73637e98ada680399b4e0c91bc0783ea
d1579de9603646c8ddec15484fb10083f5a36e79e6751cbb94e18387f5a5ca59
Linux-arm
Linux-arm
c6de319b23dfc34f692ed7e0a2ac948785e6b15a0d58fee28cb0f2b94313460c
3ed8d21ea72977712405a4abc13470a238288b0fa724029cda505ac7baa1e475
You can also use the command line to get the COSCLI tool files for Mac and Linux environments from a domestic site:
Mac-amd64:wget https://cosbrowser.cloud.tencent.com/software/coscli/coscli-darwin-amd64
Mac-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
Note:
The current version on GitHub is v1.0.3. To get the latest version, historical versions, and change logs of the tool, please go to release to view.

Step 2: Install the COSCLI Tool

Windows

1. Move the downloaded Windows version of the COSCLI tool to the C:\\Users\\< username > directory.
2. Rename coscli-windows.exe to coscli.exe.
3. Press win+r to open the Run program.
4. In the dialog box, enter cmd and press Enter to open the command line window.
5. Enter coscli --version in the command line window. If the following information is printed out, the installation is successful:
Note:
Under the Windows system, the method of using COSCLI in different command line clients may vary slightly. If entering coscli [command] does not work properly with COSCLI, please try the format ./coscli [command].
coscli version v1.0.3

Mac

1. Run the following command to rename the macOS version COSCLI file:
mv coscli-mac coscli
2. Run the following command to modify the file execution permission:
chmod 755 coscli
3. Enter ./coscli --version in the command line, and if the following information is printed out, the installation is successful:
coscli version v1.0.3
Note:
When using COSCLI on a macOS, if the prompt Unable to open "coscli" because the developer cannot be verified appears, you can go to Settings > Security and Privacy > General and select Still want to open coscli, afterwards COSCLI can be used normally.

Linux

1. Run the following command to rename the Linux version COSCLI file:
mv coscli-linux coscli
2. Run the following command to modify the file execution permission:
chmod 755 coscli
3. Enter ./coscli --version in the command line window. If the following information is printed out, the installation is successful:
coscli version v1.0.3

Step 3: Configure COSCLI Tool

Note:
It is recommended that users use the tool with a Temporary Key to further enhance its security through temporary authorization. When applying for a Temporary Key, please follow the Principle of Least Privilege to prevent leaking resources outside the targeted buckets or objects.
If you must use a permanent key, it is recommended to follow the Principle of Least Privilege to limit the permission scope of the permanent key.
When using COSCLI for the first time, you need to initialize the configuration file, which contains the following two parts:
1. To authorize COSCLI to access your Tencent Cloud account, you need to configure the secret ID, secret key, and temporary key token.
2. To add an alias for a common bucket, you need to configure its name, geographical information, and alias. After configuring this information, users can use the alias for bucket operations without having to fill in the bucket name and geographical information again. Adding configurations for multiple common buckets also facilitates cross-bucket or cross-domain operations more easily. If you don't need to configure common bucket information, you can press Enter to skip.
When using COSCLI for the first time, it will automatically call ./coscli config init to create a configuration file at ~/.cos.yaml. You can complete the setup interactively through the command line. Later, you can also use ./coscli config init to interactively generate a configuration file in another location for COSCLI. You can use ./coscli config show to view the location and configuration parameters of the file.
The configuration items in the configuration file are as described below:
Configuration Item
Description
Secret ID
Key ID, it is recommended to use a sub-account key and follow the principle of least privilege to reduce risks. Information on obtaining a sub-account key can be found in Sub-account Access Key Management.
Secret Key
Key, it is recommended to use a sub-account key and follow the principle of least privilege to reduce risks. Information on obtaining a sub-account key can be found in Sub-account Access Key Management.
Session Token
Temporary key token, needs to be configured when using a temporary key; otherwise you can skip by pressing Enter. For more information on temporary keys, see Accessing COS Using a Temporary Key.
Mode
Set the identity mode, supporting enumerated values SecretKey and CvmRole. It can be null, with the default null value being SecretKey, indicating the use of a key request COS. When Mode is CvmRole, it means using Managing Instances Roles to request COS.
Cvm Role Name
Set the CVM role instance name, see Managing Instances Roles for details.
protocol
Network transfer protocol, which is HTTPS by default. If you want to change it to HTTP, directly modify it in the configuration file.
APPID
APPID is the account you receive after successfully applying for a Tencent Cloud account, automatically assigned by the system, and can be obtained from Account Information. A bucket's full name is composed of two elements: Bucket Name and APPID, formatted as <BucketName-APPID>, for details please refer to Bucket Naming Conventions.
Bucket Name
Bucket name, together with APPID, constitutes the bucket's full name, formatted as <BucketName-APPID>, for details please refer to Bucket Naming Conventions.
Bucket Endpoint
Domain name of the region where the bucket is located, default domain format is cos.<region>.myqcloud.com, where <region> represents the bucket's region, such as ap-guangzhou, ap-beijing, etc. For a list of supported regions by COS, see Regions and Access Endpoints.
If the bucket has global acceleration enabled, you can configure a global acceleration domain name. For example, the global acceleration domain name is set to cos.accelerate.myqcloud.com; the internal network global acceleration domain name is set to cos-internal.accelerate.tencentcos.cn.
Bucket Alias
Bucket alias, once configured, you can use BucketAlias to replace BucketName-APPID, reducing the command length required for input. If this option is not configured, the value of BucketAlias is the same as BucketName-APPID.
OFS Bucket
Metadata acceleration bucket tag, used to identify whether the bucket has the metadata acceleration feature enabled.
Auto Switch Host
Set whether to disable automatic switch of a backup domain. Optional values are true and false, which can be null.
If the value is not set or set to false, the backup domain switch will be executed;
If the value is set to true, the backup domain switch will not be executed.
During the initial configuration, COSCLI will ask you to configure information for just one bucket. If you want to configure multiple buckets, you can later use the ./coscli config add command to add bucket configurations. If you need to modify the configuration file or learn more about operations related to the configuration file, refer to the config command or use the ./coscli config --help command for quick access to related instructions.
Before starting to use commands, you can quickly check how to use COSCLI by running the command ./coscli --help.

Other configuration methods

In addition to generating the configuration file interactively with the ./coscli config init command, you can also manually write the COSCLI configuration file. The format of the COSCLI configuration file is in yaml format, with an example configuration as follows:
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
Note:
COSCLI by default reads configuration items from ~/.cos.yaml. If users want to use their own defined configuration file, please use the -c (--config-path) option in the command. The configuration for CFS's secretid/secretkey/sessiontoken are all encrypted strings.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon