Download and install the command-line tool ossutil - Object Storage Service

ossutil is a command-line tool that you can use to quickly upload large files, download files, and delete files with a specific prefix. ossutil runs on operating systems such as Windows, Linux, and macOS. You can download and install the version that is suitable for your environment.

New version available

We recommend that you use the upgraded ossutil 2.0. For more information about how to quickly install and use it, see Install ossutil.

Key features of ossutil 2.0:

New command structure: Supports multi-level commands, including API-level commands such as ossutil api put-bucket-acl and high-level commands such as ossutil config.
Improved configuration management: The initial configuration process is simplified. You only need to provide the AccessKey ID, AccessKey secret, and region ID to complete the basic configuration after installation. You can also use the --profile parameter to specify multiple configuration files for greater flexibility.
More filter parameters: For batch processing commands such as ls, cp, and rm, it supports various filter conditions based on path, file size, modification time, and object metadata. This support greatly improves the accuracy and efficiency of operations.
Flexible output formats: The --output-format parameter lets you set the output format to JSON, YAML, or XML to meet different data processing requirements. The --output-query option lets you filter the output to retrieve the required information.
Enhanced security: To improve security, ossutil 2.0 lets you set sensitive parameters using environment variables. This prevents you from exposing keys in the command line and reduces the risk of data leaks. In addition, the --dry-run option lets you verify the behavior of a command before you run it, which helps prevent unintended operations.

Versions

Current version: 1.7.19
Previous versions: For more information about the source code and release history of previous ossutil versions, see GitHub.

Download links

Download link	SHA-256 checksum
Linux x86 32-bit	f8a4a7e1df8529b06a3f3cca194a1c99163cb3b8ab3b5d64228c207c3ae63b86
Linux x86 64-bit	dcc512e4a893e16bbee63bc769339d8e56b21744fd83c8212a9d8baf28767343
Linux ARM 32-bit	ffe8b479e5fd3c0e146a14cd32e8ef5736d23f6c8de157944288ee09db2d7b1d
Linux ARM 64-bit	f612c2a88d4d28363e254168d521fac5df632f2547ba84eaebacf6497dc04d57
macOS 64-bit	9cf82a53fe24d8b5cc3dfb441787e0ea19c24dd7a1246653d5f1a28b7923d6fe
macOS ARM 64-bit	10ece4d328c5d2440833adc5f4167168e9b2a4c5d364f673b0c45bcc4fd02ec5
Windows x86 32-bit	772469ef02b91e893f7211acf732c2c07cd93214552ed7cf84157d3d9b9fb799
Windows x86 64-bit	8e9176aedc87d230ccd97dc7236b16564f2a068609ed301acdc73dc27faf7e77

Download and install ossutil

Linux

Install ossutil.
```
sudo -v ; curl https://gosspublic.alicdn.com/ossutil/install.sh | sudo bash
```
Note
- You must decompress the ossutil package before installation. Ensure that you have a decompression tool, such as unzip or 7z, installed.
- By default, ossutil is installed in the /usr/bin/ directory.

Configure ossutil.

Enter the configuration command.
```
ossutil config
```
When prompted, configure the path of the configuration file.
```
Please enter the config file name. The file name can include a path. (Default: /home/user/.ossutilconfig. Press Enter to use the default path.
If you set the path to another file, you must specify the --config-file option to the file when you use other commands): 
```
By default, ossutil saves the configuration file to /home/user/.ossutilconfig. If you specify a different path for the configuration file, you must add the -c option to specify the configuration file each time you run an ossutil command. For example, if you save the configuration file to /home/config, run the ls command in the following format and include the -c option:
```
ossutil ls oss://examplebucket -c /home/config
```
When prompted, set the language for the tool. Enter CH for Chinese or EN for English. By default, the tool uses the language of your operating system. This setting takes effect after the config command is successfully run.
Set the language for the tool.
Enter CH or EN. By default, the tool uses the same language as your operating system. This configuration takes effect after you run the config command.

When prompted, set the Endpoint, AccessKey ID, AccessKey secret, and STSToken parameters. The STSToken parameter is required only when you use temporary credentials from the Security Token Service (STS) to access OSS. Otherwise, leave this parameter empty.

The parameters are described as follows:

Parameter	Required	Description
endpoint	Yes	Enter the endpoint for the region where your bucket is located. For example, set the public endpoint to for the region or `https://oss-ap-southeast-1.aliyuncs.com` for the Singapore region. To access OSS from other Alibaba Cloud services in the same region, use an internal endpoint, such as or `https://oss-ap-southeast-1-internal.aliyuncs.com`. For more information about the endpoints of each region, see Regions and endpoints. Important Due to a policy change to improve compliance and security, starting March 20, 2025, new OSS users must use a custom domain name (CNAME) to perform data API operations on OSS buckets located in Chinese mainland regions. Default public endpoints are restricted for these operations. Refer to the official announcement for a complete list of the affected operations. If you access your data via HTTPS, you must bind a valid SSL Certificate to your custom domain. This is mandatory for OSS Console access, as the console enforces HTTPS.
accessKeyID	Yes	Enter the AccessKey pair of your account. For more information about how to obtain an AccessKey pair, see Create an AccessKey pair. Quickly create an AccessKey pair for a RAM user with OSS management permissions using a ROS script On the Create Stack page of the Resource Orchestration Service (ROS) console, select the confirmation checkbox in the Security Confirmation section, and then click Create. For more information, see Create a stack. After the stack is created, copy the created AccessKey pair from the Outputs tab.
accessKeySecret	Yes
stsToken	No	This parameter is required only when you use temporary access credentials to access OSS. Otherwise, leave this parameter empty. For more information about how to generate an STS token, see AssumeRole.

Verify that ossutil is installed.
```
ossutil
```
If a list of supported ossutil commands is displayed, the installation is successful.

Windows

Install ossutil.
1. Click the download link to download the Windows installation package.
2. Decompress the package and double-click the ossutil.bat file.

Configure ossutil.

Enter the configuration command.
```
ossutil config
```
When prompted, set the path for the configuration file.
```
Please enter the config file name. The file name can include a path. (Default: C:\\Users\user\.ossutilconfig. Press Enter to use the default path.
If you set the path to another file, you must specify the --config-file option to the file when you use other commands): 
```
By default, ossutil saves the configuration file to C:\\Users\user\.ossutilconfig. If you specify a different path for the configuration file, you must add the -c option to specify the configuration file each time you run a command. For example, if the configuration file is saved to c:\ossutil\config, run the ls command in the following format:
```
ossutil ls oss://examplebucket -c c:\ossutil\config
```
When prompted, set the language for the tool. Enter CH for Chinese or EN for English. By default, the tool uses the language of your operating system. This configuration takes effect after you run the config command.

When prompted, set the Endpoint, AccessKey ID, AccessKey secret, and STSToken parameters. The STSToken parameter is required only when you use temporary credentials from STS to access OSS. Otherwise, leave this parameter empty.

The following table describes the parameters.

Parameter	Required	Description
endpoint	Yes	Enter the endpoint for the region where your bucket is located. For example, set the public endpoint to for the region or `https://oss-ap-southeast-1.aliyuncs.com` for the Singapore region. To access OSS from other Alibaba Cloud services in the same region, use an internal endpoint, such as or `https://oss-ap-southeast-1-internal.aliyuncs.com`. For more information about the endpoints of each region, see Regions and endpoints. Important Due to a policy change to improve compliance and security, starting March 20, 2025, new OSS users must use a custom domain name (CNAME) to perform data API operations on OSS buckets located in Chinese mainland regions. Default public endpoints are restricted for these operations. Refer to the official announcement for a complete list of the affected operations. If you access your data via HTTPS, you must bind a valid SSL Certificate to your custom domain. This is mandatory for OSS Console access, as the console enforces HTTPS.
accessKeyID	Yes	Enter the AccessKey pair of your account. For more information about how to obtain an AccessKey pair, see Create an AccessKey pair. Quickly create an AccessKey pair for a RAM user with OSS management permissions using a ROS script On the Create Stack page of the Resource Orchestration Service (ROS) console, select the confirmation checkbox in the Security Confirmation section, and then click Create. For more information, see Create a stack. After the stack is created, copy the created AccessKey pair from the Outputs tab.
accessKeySecret	Yes
stsToken	No	This parameter is required only when you use temporary access credentials to access OSS. Otherwise, leave this parameter empty. For more information about how to generate an STS token, see AssumeRole.

Verify that ossutil is installed.
```
ossutil
```
If a list of supported ossutil commands is displayed, the installation is successful.

macOS

Install ossutil.

sudo -v ; curl https://gosspublic.alicdn.com/ossutil/install.sh | sudo bash

Note

The default installation directory is /usr/local/bin.

Configure ossutil.

Enter the configuration command.
```
ossutil config
```
When prompted, set the path for the configuration file.
```
Please enter the config file name. The file name can include a path. (Default: /Users/user/.ossutilconfig. Press Enter to use the default path.
If you set the path to another file, you must specify the --config-file option to the file when you use other commands): 
```
By default, ossutil saves the configuration file to /Users/user/.ossutilconfig.
If you specify a different path for the configuration file, you must add the -c option to specify the configuration file each time you run a command. For example, if the configuration file is saved to /home/config, run the ls command in the following format:
```
ossutil ls oss://examplebucket -c /home/config
```
When prompted, set the language for the tool. Enter CH for Chinese or EN for English. By default, the tool uses the language of your operating system. This configuration takes effect after you run the config command.

The following table describes the parameters.

Parameter	Required	Description
endpoint	Yes	Enter the endpoint for the region where your bucket is located. For example, set the public endpoint to for the region or `https://oss-ap-southeast-1.aliyuncs.com` for the Singapore region. To access OSS from other Alibaba Cloud services in the same region, use an internal endpoint, such as or `https://oss-ap-southeast-1-internal.aliyuncs.com`. For more information about the endpoints of each region, see Regions and endpoints. Important Due to a policy change to improve compliance and security, starting March 20, 2025, new OSS users must use a custom domain name (CNAME) to perform data API operations on OSS buckets located in Chinese mainland regions. Default public endpoints are restricted for these operations. Refer to the official announcement for a complete list of the affected operations. If you access your data via HTTPS, you must bind a valid SSL Certificate to your custom domain. This is mandatory for OSS Console access, as the console enforces HTTPS.
accessKeyID	Yes	Enter the AccessKey pair of your account. For more information about how to obtain an AccessKey pair, see Create an AccessKey pair. Quickly create an AccessKey pair for a RAM user with OSS management permissions using a ROS script On the Create Stack page of the Resource Orchestration Service (ROS) console, select the confirmation checkbox in the Security Confirmation section, and then click Create. For more information, see Create a stack. After the stack is created, copy the created AccessKey pair from the Outputs tab.
accessKeySecret	Yes
stsToken	No	This parameter is required only when you use temporary access credentials to access OSS. Otherwise, leave this parameter empty. For more information about how to generate an STS token, see AssumeRole.

Verify that ossutil is installed.
```
ossutil
```
If a list of supported ossutil commands is displayed, the installation is successful.

References

After you install ossutil, you can use it to upload, download, copy, and delete objects. For more information, see cp (upload objects), cp (download objects), cp (copy objects), and rm (delete objects).