This topic describes how to download and install ossutil.

Version and runtime environment

  • Current version: 1.6.6
  • Source code: ossutil
  • Runtime environment
    • Windows/Linux/macOS
    • Supported architectures: x86 (32-bit and 64-bit)

Download URLs

Quick installation

Download the package based on your operating system and run the corresponding binary file.
  • Install ossutil in Linux (the 64-bit Linux system is used as an example)
    1. Download the ossutil installation package:
      wget http://gosspublic.alicdn.com/ossutil/1.6.6/ossutil64                           
    2. Modify the file execution permissions:
      chmod 755 ossutil64
    3. Generate a configuration file by following the interactive processing:
      ./ossutil64 config
      This command generates a configuration file. Enter the path of the configuration file. The default path is /home/user/.ossutilconfig. If you press Enter without specifying a different destination, the file will be generated in the default path. If you want to generate the file in another path, set the --config-file option to the path. 
      If the path of the configuration file is not entered, the default configuration file /home/user/.ossutilconfig is used. 
      A parameter is ignored if you press Enter without configuring it. To learn more about parameters, run the help config command. 
      Enter the endpoint: http://oss-cn-shenzhen.aliyuncs.com 
      Enter the AccessKey ID: your AccessKey ID 
      Enter the AccessKey secret: your AccessKey secret
      Enter the STS token: 
      • Bucket-Endpoint: specifies an individual endpoint for each specified bucket. If you configure the Bucket-Endpoint option, ossutil searches for the specified endpoint when you perform operations on the bucket. If the specified endpoint exists, ossutil manages the bucket through that endpoint. Otherwise, ossutil manages the bucket through the endpoint specified in the Credentials option.
      • Bucket-Cname: specifies an individual origin domain for each specified bucket. If you configure the Bucket-Cname option, ossutil searches for the specified origin domain when you perform operations on the bucket. If the specified origin domain exists, ossutil replaces the endpoints specified in the Bucket-Endpoint and Credentials options with the origin domain. For more information about origin domains, see Configure CNAME.
      • AkService: This option is not added by default. This option is required if you need to use a RAM role bound to an ECS instance to perform operations on OSS. When you configure this option, you need only to set EcsRamRoleTesting to the RAM role bound to the ECS instance. After configuring the AkService option, you do not need to configure the accessKeyID, accessKeySecret, and stsToken options. If these options are configured, the configurations of these options instead of the AkService option take effect. For more information about how to bind a RAM role to an ECS instance, see Use RAM roles in the console. For more information about how to bind a RAM role to an ECS instance, see Use the instance RAM role in the console.
      Note For more information about the configuration file, see config.
  • Install ossutil in Windows (the 64-bit Windows system is used as an example)
    1. Download the ossutil installation package.
    2. Decompress the package to a specified folder, and then double-click the ossutil.bat file.
    3. Generate the configuration file. For more information about the parameters, see the configuration parameters described in the preceding Linux section.
      D:\ossutil>ossutil64.exe config
  • Install ossutil in macOS (the 64-bit macOS system is used as an example)
    1. Download the ossutil installation package.
      curl -o ossutilmac64 http://gosspublic.alicdn.com/ossutil/1.6.6/ossutilmac64
    2. Modify the file execution permissions:
      chmod 755 ossutilmac64
    3. Generate the configuration file. For more information about the parameters, see the configuration parameters described in the preceding Linux section.
      ./ossutilmac64 config