All Products
Search
Document Center

Object Storage Service:Install ossutil

Last Updated:Sep 11, 2024

ossutil allows you to efficiently manage objects in Object Storage Service (OSS). For example, you can use ossutil to upload large objects, download objects, and delete objects whose names contain a specific prefix. ossutil supports the following OSs: Windows, Linux, and macOS. You can download and install an ossutil version that meets your business requirements.

Versions

  • Latest version: 1.7.19

  • Earlier versions: For more information about the source code and release records of ossutil versions, visit GitHub.

Download links

Download link

SHA-256 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

  1. Run the following command to download and install ossutil:

    sudo -v ; curl https://gosspublic.alicdn.com/ossutil/install.sh | sudo bash
    Note
    • The ossutil package must be decompressed before it can be installed. Make sure that you have installed an appropriate decompression tool, such as unzip or 7z.

    • By default, ossutil is installed in the /usr/bin/ directory.

  2. Configure ossutil.

    1. Run the following command to configure ossutil:

      ossutil config
    2. Configure the path of the configuration file.

      Specify the name of the configuration file. The name of the configuration file can contain the file path. The default name of the configuration file is /home/user/.ossutilconfig. If you press the Enter key without specifying a path, the default path is used. 
      If you want to store the file in another path, set the --config-file option to the path.

      By default, ossutil saves the configuration file as /home/user/.ossutilconfig. If you specify a different path for the configuration file, add the -c option to specify the configuration file each time you run an ossutil 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:

      ossutil ls oss://examplebucket -c /home/config
    3. Follow the on-screen instructions to specify the display language of ossutil. Enter EN. By default, ossutil is displayed in the language that is used by the OS. The configuration takes effect after the config command is successfully run.

    4. Configure access credentials. If you want to configure long-term access credentials, configure the AccessKey ID and AccessKey Secret parameters and leave the STSToken parameter empty. For more information about how to create an AccessKey pair and select an endpoint, see Obtain an AccessKey pair and Regions and endpoints. For more information about how to configure ossutil, see Run the config command to quickly configure ossutil.

      Note

      You can implement temporary authorization by using security tokens provided by Security Token Service (STS). For more information, see Use temporary access credentials provided by STS to access OSS.

      After you obtain temporary access credentials, provide them when you configure the SecurityToken, AccessKey ID, and AccessKey Secret parameters.

  3. Run the following command to check whether ossutil is installed:

    ossutil

    If a list of ossutil commands are displayed, ossutil is installed.

Windows

  1. Install ossutil.

    1. Click the link to the installation package for Windows to download the package.

    2. Decompress the installation package. Then, run the ossutil.bat file.

  2. Configure ossutil.

    1. Run the following command to configure ossutil:

      ossutil config
    2. Configure the path of the configuration file.

      Specify the name of the configuration file. The name of the configuration file can contain the file path. The default name of the configuration file is C:\\Users\user\.ossutilconfig. If you press the Enter key without specifying a path, the default path is used. 
      If you want to store the file in another path, set the --config-file option to the path.

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

      ossutil ls oss://examplebucket -c c:\ossutil\config
    3. Follow the on-screen instructions to specify the display language of ossutil. Enter EN. By default, ossutil is displayed in the language that is used by the OS. The configuration takes effect after you run the config command.

    4. Configure access credentials. If you want to configure long-term access credentials, configure the AccessKey ID and AccessKey Secret parameters and leave the STSToken parameter empty. For more information about how to create an AccessKey pair and select an endpoint, see Obtain an AccessKey pair and Regions and endpoints. For more information about how to configure ossutil, see Run the config command to quickly configure ossutil.

      Note

      You can implement temporary authorization by using security tokens provided by STS. For more information, see Use temporary access credentials provided by STS to access OSS.

      After you obtain temporary access credentials, provide them when you configure the SecurityToken, AccessKey ID, and AccessKey Secret parameters.

  3. Run the following command to check whether ossutil is installed:

    ossutil

    If a list of ossutil commands are displayed, ossutil is installed.

macOS

  1. Run the following command to download and 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 directory.

  2. Configure ossutil.

    1. Run the following command to configure ossutil:

      ossutil config
    2. Configure the path of the configuration file.

      Specify the name of the configuration file. The name of the configuration file can contain the file path. The default name of the configuration file is /Users/user/.ossutilconfig. If you press the Enter key without specifying a path, the default path is used. 
      If you want to store the file in another path, set the --config-file option to the path.

      By default, ossutil saves the configuration file as /Users/user/.ossutilconfig. If you specify a different path of the configuration file, add the -c option to specify the configuration file each an ossutil 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:

      ossutil ls oss://examplebucket -c /home/config
    3. Follow the on-screen instructions to specify the display language of ossutil. Enter EN. By default, ossutil is displayed in the language that is used by the OS. The configuration takes effect after the config command is successfully run.

    4. Configure access credentials. If you want to configure long-term access credentials, configure the AccessKey ID and AccessKey Secret parameters and leave the STSToken parameter empty. For more information about how to create an AccessKey pair and select an endpoint, see Obtain an AccessKey pair and Regions and endpoints. For more information about how to configure ossutil, see Run the config command to quickly configure ossutil.

      Note

      You can implement temporary authorization by using security tokens provided by STS. For more information, see Use temporary access credentials provided by STS to access OSS.

      After you obtain temporary access credentials, provide them when you configure the SecurityToken, AccessKey ID, and AccessKey Secret parameters.

  3. Run the following command to check whether ossutil is installed:

    ossutil

    If a list of ossutil commands are displayed, ossutil is installed.

References

After ossutil is installed, you can use ossutil to upload objects, download objects, copy objects, delete objects, and perform other operations. For more information, see Upload objects, Download objects, Copy objects, and rm.