ossutil supports the following operating systems: Windows, Linux, and macOS. You can download and install a suitable ossutil version to meet your business requirements.

Versions and runtime environments

  • Versions
    • Current version: 1.7.14
    • Previous versions: For more information about the source code and release records of ossutil versions, visit GitHub.
  • Runtime environments
    • Windows, Linux, and macOS
    • Supported architectures: x86 (32-bit and 64-bit) and ARM (32-bit and 64-bit)

Download URLs

ossutil 1.7.8 is compiled by using Go 1.16. ossutil does not support the macOS x86 32-bit operating system. The ossutilmac32 installation package is no longer provided by ossutil 1.7.8 or later.

Download the ossutil installation package that corresponds to your operating system and perform the following steps to install and configure ossutil. In this topic, ossutil is installed on 64-bit operating systems.

Install ossutil on Linux

  1. Run the following command to download the ossutil installation package:
    wget https://gosspublic.alicdn.com/ossutil/1.7.14/ossutil64                           
    Important When you specify the URL in the wget command to download the ossutil installation package, delete ?spm=xxxx from the URL.
  2. Run the following command to modify the execution permissions on the ossutil installation package:
    chmod 755 ossutil64
  3. Generate a configuration file in interactive mode.
    1. Run the following command:
      ./ossutil64 config
    2. Follow the on-screen instructions to configure the path of the configuration file.
      We recommend that you press the Enter key to use the default path of the configuration file.
      Specify the name of the configuration file. The file name can contain the file path. The default file name is /home/user/.ossutilconfig. If you press the Enter key without specifying a path, the file is generated in the default path. 
      If you want to store the file in another path, set the --config-file option to the path. 

      By default, ossutil uses /home/user/.ossutilconfig as the configuration file. If you specify the path of the configuration file, add the -c option to specify the configuration file each time you run this command. For example, if you save the configuration file as /home/config, add the -c option in the following format when you run the ls command:

      ./ossutil64 ls oss://examplebucket -c /home/config
    3. Follow the on-screen instructions to configure the display language of ossutil.
      Enter CH or EN. By default, ossutil is displayed in the language that is used by the operating system. The configuration takes effect after you run the config command.
    4. Follow the on-screen instructions to configure the following parameters: endpoint, accessKeyID, accessKeySecret, and stsToken.
      The following table describes the parameters.
      Parameter Description
      endpoint Specify the endpoint of the region in which the bucket is located. For more information about the relationship between regions and endpoints, see Regions and endpoints.

      You can also add http:// or https:// to specify the protocol that you want ossutil to use to access Object Storage Service (OSS). The default protocol is HTTP. For example, if you want to access a bucket in the China (Hangzhou) region by using HTTPS, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com.

      accessKeyID Specify the AccessKey pair of the Alibaba Cloud account or the RAM user that you want to use to access OSS.
      accessKeySecret
      stsToken This parameter is required only when you use temporary access credentials to access an OSS bucket. If you do not use temporary access credentials to access an OSS bucket, you can leave this parameter empty. For more information about how to generate an STS token, see the "Temporary access credentials" section in Authorized third-party upload.
      Note For more information about the configuration file, see config.
    5. Run the following command to check whether ossutil is installed:
      ./ossutil64

      If all commands supported by ossutil are displayed, ossutil is installed.

Install ossutil on Windows

  1. Click the download URL to download the ossutil installation package for Windows.
  2. Decompress the downloaded installation package. Then, run the ossutil.bat file.
  3. Run the following command to generate a configuration file:
    D:\ossutil>ossutil64.exe config
  4. Follow the on-screen instructions to configure the configuration file. You can configure the configuration file in the same manner as you configure the configuration file in Linux. For more information, see Step 3 in the "Install ossutil on Linux" section.
  5. Run the following command to check whether ossutil is installed:
    ossutil64.exe

    If all commands supported by ossutil are displayed, ossutil is installed.

Install ossutil on macOS

  1. Run the following command to download the ossutil installation package:
    curl -o ossutilmac64 https://gosspublic.alicdn.com/ossutil/1.7.14/ossutilmac64
  2. Run the following command to modify the execution permissions on the ossutil installation package:
    chmod 755 ossutilmac64
  3. Run the following command to generate a configuration file:
    ./ossutilmac64 config
  4. Follow the on-screen instructions to configure the configuration file. You can configure the configuration file in the same manner as you configure the configuration file in Linux. For more information, see Step 3 in the "Install ossutil on Linux" section.
  5. Run the following command to check whether ossutil is installed:
    ./ossutilmac64

    If all commands supported by ossutil are displayed, ossutil is installed.

Install ossutil on ARM

  1. Run the following command to download the ossutil installation package:
    wget https://gosspublic.alicdn.com/ossutil/1.7.14/ossutilarm64
  2. Run the following command to modify the execution permissions on the ossutil installation package:
    chmod 755 ossutilarm64
  3. Run the following command to generate a configuration file:
    ./ossutilarm64 config
  4. Follow the on-screen instructions to configure the configuration file. You can configure the configuration file in the same manner as you configure the configuration file in Linux. For more information, see Step 3 in the "Install ossutil on Linux" section.
  5. Run the following command to check whether ossutil is installed:
    ./ossutilarm64

    If all commands supported by ossutil are displayed, ossutil is installed.