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

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

Version upgrade

Upgrade to ossutil 2.0. For information about how to quickly install and use it, see Install ossutil.

Key features of ossutil 2.0:

New command organization chart: ossutil 2.0 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 flow is simplified. You need to provide only an AccessKey ID, an AccessKey secret, and a region ID to complete the basic configuration. You can also use the --profile parameter to specify multiple configuration files for enhanced flexibility.
Rich parameter filtering: For batch processing commands such as ls, cp, and rm, multiple filter conditions are added based on the path, file size, modification time, and object metadata. This feature greatly improves the precision and efficiency of operations.
Flexible output format adjustment: The --output-format parameter is added to allow you to set the output format to JSON, YAML, or XML to meet different data processing needs. The --output-query option is introduced to allow you to filter the output and retrieve the required information.
Enhanced security: To improve security, ossutil 2.0 lets you set sensitive parameters using environment variables. This practice prevents keys from being exposed on the command line and reduces the threat of leaks. In addition, the new --dry-run option lets you authenticate the behavior of a command before you run it to ensure that the operation is correct.

Versions

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

Download links

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

Download and install ossutil

Linux

Install ossutil.
```
sudo -v ; curl https://gosspublic.alicdn.com/ossutil/install.sh | sudo bash
```
Note
- A decompression tool, such as unzip or 7z, is required to decompress the software package. Make sure that you install one of these tools in advance.
- After the installation is complete, ossutil is installed in the /usr/bin/ folder.

Configure ossutil.

Enter the configuration command.
```
ossutil config
```
Set the path of the configuration file as prompted.
```
Enter the configuration file name. The file name can include a path. (The default path is /home/user/.ossutilconfig. Press Enter to use the default path.
If you set a different path, you must use the --config-file option to specify the path when you run commands.): 
```
By default, ossutil uses /home/user/.ossutilconfig as the configuration file. If you specify a custom 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, the command to run ls is in the following format:
```
ossutil ls oss://examplebucket -c /home/config
```
When prompted, set the language for the tool. Enter CH or EN. By default, the language of the tool is the same as the language of your operating system. This configuration item takes effect after the config command runs successfully.
Set the language for the tool.
Enter CH or EN. The default language is inherited from the operating system. The change takes effect after the config command is run.

As prompted, set the Endpoint, AccessKey ID, AccessKey secret, and STSToken parameters. If you use a temporary account that is authorized by Security Token Service (STS) to access OSS, you must configure the STSToken parameter. Otherwise, leave this parameter empty and press Enter.

The following table describes the parameters.

Parameter	Required	Description
endpoint	Yes	Specify the endpoint of the region in which the bucket is located. For example, the public endpoint for the Singapore region is `https://oss-ap-southeast-1.aliyuncs.com`. If you want to access OSS from other Alibaba Cloud products in the same region as OSS, 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 of your account. For more information about how to obtain an AccessKey, see Create an AccessKey. Use a ROS script to quickly create an AccessKey for a RAM user that has OSS management permissions On the Create Stack page in the ROS console, in the Security Confirmation section, select the confirmation checkbox and click Create. After the stack is created, copy the created AccessKey from the Outputs tab.
accessKeySecret	Yes
stsToken	No	This parameter must be configured when you use a temporary account authorized by STS to access OSS. Otherwise, leave it empty and skip this step. For more information about how to generate an stsToken, see AssumeRole - Obtain temporary identity credentials of a role.

Verify that ossutil is installed.
```
ossutil
```
If the supported commands of ossutil are displayed on the screen, the installation is successful.

Windows

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

Configure ossutil.

Enter the configuration command.
```
ossutil config
```
Set the path of the configuration file as prompted.
```
Enter the configuration file name. The file name can include a path. (The default path is C:\\Users\user\.ossutilconfig. Press Enter to use the default path.
If you set a different path, you must use the --config-file option to specify the path when you run commands.): 
```
By default, ossutil uses C:\Users\user\.ossutilconfig as the configuration file. If you specify a custom 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, the command to run ls is in the following format:
```
ossutil ls oss://examplebucket -c c:\ossutil\config
```
As prompted, set the language for the tool. Enter CH or EN. By default, the tool uses the language of your operating system. This setting takes effect after the config command runs successfully.

As prompted, set the Endpoint, AccessKey ID, AccessKey secret, and STSToken parameters. If you use a temporary account that is authorized by STS to access OSS, you must configure the STSToken parameter. Otherwise, leave this parameter empty and press Enter.

The following table describes the parameters.

Parameter	Required	Description
endpoint	Yes	Enter the Endpoint for the bucket's region. For example, the public Endpoint for the China (Hangzhou) region is `https://oss-cn-hangzhou.aliyuncs.com`. To access OSS from other Alibaba Cloud products in the same region, use the internal network Endpoint: `https://oss-cn-hangzhou-internal.aliyuncs.com`. For more information about the Endpoints of each region, see Regions and endpoints.
accessKeyID	Yes	Enter the AccessKey of your account. For more information about how to obtain an AccessKey, see Create an AccessKey. Use a ROS script to quickly create an AccessKey for a RAM user that has OSS management permissions On the Create Stack page of the Resource Orchestration Service (ROS) console, under Security Confirmation, select the checkbox to confirm, and then click Create. After the stack is created, copy the created AccessKey from the Outputs tab.
accessKeySecret	Yes
stsToken	No	This parameter must be configured when you use a temporary account authorized by STS to access OSS. Otherwise, leave it empty and skip this step. For more information about how to generate an stsToken, see AssumeRole - Obtain temporary identity credentials of a role.

Verify that ossutil is installed.
```
ossutil
```
If the supported commands of ossutil are displayed on the screen, the installation is successful.

macOS

Install ossutil.
```
sudo -v ; curl https://gosspublic.alicdn.com/ossutil/install.sh | sudo bash
```
Note
By default, ossutil is installed in the /usr/local/bin folder.

Configure ossutil.

Enter the configuration command.
```
ossutil config
```
Set the path of the configuration file as prompted.
```
Enter the configuration file name. The file name can include a path. (The default path is /Users/user/.ossutilconfig. Press Enter to use the default path.
If you set a different path, you must use the --config-file option to specify the path when you run commands.): 
```
By default, ossutil uses /Users/user/.ossutilconfig as the configuration file.
If you specify a custom 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, the command to run ls is in the following format:
```
ossutil ls oss://examplebucket -c /home/config
```
As prompted, set the language for the tool. Enter CH or EN. By default, the tool uses the language of your operating system. This setting takes effect after the config command runs successfully.

The following table describes the parameters.

Parameter	Required	Description
endpoint	Yes	Specify the endpoint of the region in which the bucket is located. For example, the public endpoint for the Singapore region is `https://oss-ap-southeast-1.aliyuncs.com`. If you want to access OSS from other Alibaba Cloud products in the same region as OSS, 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 of your account. For more information about how to obtain an AccessKey, see Create an AccessKey. Use a ROS script to quickly create an AccessKey for a RAM user that has OSS management permissions In the Resource Orchestration Service (ROS) console, on the Create Stack page, in the Security Confirmation section, select the confirmation checkbox and click Create. After the stack is created, copy the created AccessKey from the Outputs tab.
accessKeySecret	Yes
stsToken	No	This parameter must be configured when you use a temporary account authorized by STS to access OSS. Otherwise, leave it empty and skip this step. For more information about how to generate an stsToken, see AssumeRole - Obtain temporary identity credentials of a role.

Verify that ossutil is installed.
```
ossutil
```
If the supported commands of ossutil are displayed on the screen, the installation is successful.

References

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