Docs

Torch Object Storage

tosutil

Command syntax

This topic describes the syntax of the commands and the common command parameters available in tosutil.

General format

Windows

tosutil [command] [args...] [options...]

macOS/Linux

./tosutil [command] [args...] [options...]

Parameter	Description
[command]	Stands for the name of the command to run, for example, ls, cp and rm.
[args...]	Stands for the basic parameters of commands, which are usually mandatory. When specifying multiple parameters, use spaces to separate them.
[options...]	Stands for the optional parameters of commands. When specifying multiple parameters, use - as the prefix and = to indicate the parameter value, for example, -limit=100. warning For Boolean options, use only - (without =) to indicate that the value is true.

Common arguments

Parameter	Description
cloud_url	Specifies the path on TOS. Paths are formatted as tos://bucket/[prefix], where the prefix is optional and indicates the object name or prefix of the object name.
file_url	Specifies the path for a local file.
folder_url	Specifies the path for a local folder.

Global options

All commands, except for some special auxiliary commands, can include optional parameters. These parameters are described as follows:

Parameter	Description
-e	Specifies the endpoint of the TOS server that will run the command.
-re	Specifies the region of the TOS server that will run the command. tip For more information on TOS regions and endpoints, see Regions and endpoints.
-i	Specifies the access key ID used to run the command. tip Since access key IDs are not required for anonymous access, set the parameter to -i=.
-k	Specifies the secret access key used to run the command. tip Since secret access keys are not required for anonymous access, set the parameter to -k=.
-t	Specifies the security token used to run the command. Security tokens are only required when using temporary access credentials. tip Since security tokens are not required for anonymous access, set the parameter to -t=.
-conf	Specifies the path of the configuration file used to run the command.

warning

When both the -conf and -e/-re/-i/-k/-t parameters are set for a command, the -conf parameter remains effective while the access key ID, secret access key, and other relevant parameters in the configuration file under the specified path become ineffective. The -e/-re/-i/-k/-t parameters specified when running the command take priority.

Last updated: 2025.12.17 18:33:42