aspera: The Command-Line Transfer Client |
browse | browse a directory of a Shares server |
delete | delete a file, directory, or share |
download | download files or directories from a Shares server |
rename | rename a file or directory |
upload | upload files or directories to a Shares server |
For examples of Shares subcommands in use, see Shares Examples
# aspera shares browse [args]
Arguments for the browse subcommand:
-b path
--base-ca-path=path |
The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/certs. |
-c num
--count=num |
List only up to num items. |
-H host
--host=host |
The Shares host name. |
-i
---insecure |
Accept the certificate, even if it's invalid. |
-j
--json |
Output raw JSON. |
-k num
--skip=num |
Skip the first num items. |
-o order
--sort=order |
Sort by order. The options for order are as follows:
|
-p [password]
--password=[password] |
The Shares user password. If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value. If you do not specify -p, the Aspera CLI prompts you for a non-echoing password. Alternatively, you can set the ASPERA_PASS environment variable. For instructions, see Installing the Aspera CLI. |
-P path
--path=path |
The Shares remote path (the default is /; or use the format /shareName/relativePathTo/fileOrFolder). |
-T
port_number
--port=port_number |
The listening port on the Shares server. |
-u username
--user=username |
The Shares username. |
-v
--verbose |
Show more verbose output, for debugging. |
# aspera shares delete [args]
Arguments for the delete subcommand:
-b path
--base-ca-path=path |
The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/certs. |
-H host
--host=host |
The Shares host name. |
-i
---insecure |
Accept the certificate, even if it's invalid. |
-j
--json |
Output raw JSON. |
-p [password]
--password=[password] |
The Shares user password. If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value. If you do not specify -p, the Aspera CLI prompts you for a non-echoing password. Alternatively, you can set the ASPERA_PASS environment variable. For instructions, see Installing the Aspera CLI. |
-P path
--path=path |
The path to the remote file or directory to be deleted (with the format /shareName/relativePathTo/fileOrFolder). |
-T
port_number
--port=port_number |
The listening port on the Shares server. |
-u username
--user=username |
The Shares username. |
-v
--verbose |
Show more verbose output, for debugging. |
# aspera shares download [args]
Arguments for the download subcommand:
-b path
--base-ca-path=path |
The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/certs. |
-c
cookie_string
--cookie=cookie_string |
Cookie, if one is required. |
--cipher=cipher | Attempt to set the encryption cipher (if server settings allow). cipher
can be any of the following values:
|
--content-protect-password=password | Specify the password that is used to encrypt/decrypt files on the server. |
-d path
--destination=path |
Destination directory path (the default is ./). |
-e
--remove-empty-directories |
When the transfer is complete, remove empty directories. |
-E pattern
--exclude=pattern |
Exclude files that match the given pattern. To specify multiple patterns, repeat the -E option. |
-H host
--host=host |
The Shares host name. |
-i
---insecure |
Accept the certificate, even if it's invalid. |
--min-rate=new_rate | Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps. |
-o
overwrite_method
--overwrite=overwrite_method |
Overwrite existing files. overwrite_method can be any of the following values:
|
-p [password]
--password=[password] |
The Shares user password. If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value. If you do not specify -p, the Aspera CLI prompts you for a non-echoing password. Alternatively, you can set the ASPERA_PASS environment variable. For instructions, see Installing the Aspera CLI. |
-R
--remove-after-transfer |
When the transfer is complete, remove the transferred content from the source. |
--rate-policy=policy | Attempt to revise the rate policy (if server settings allow). The options for
policy are
|
-s path
--source=path |
File path to the source of the content you are downloading (with the format /shareName/relativePathTo/fileOrFolder). |
-T
port_number
--port=port_number |
The listening port on the Shares server. |
--target-rate=newRate | Attempt to revise the target rate (if server settings allow) to a new throughput value, in kbps. |
-u username
--user=username |
The Shares username. |
-v
--verbose |
Show more verbose output, for debugging. |
-x proxy_hostOrIp
--proxy=proxy_hostOrIp |
The hostname or IP address of the proxy computer (forward proxy). |
# aspera shares rename [args]
Arguments for the rename subcommand:
-b path
--base-ca-path=path |
The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/certs. |
-d path
--destination=path |
The new name for the file or directory. |
-H host
--host=host |
The Shares host name. |
-i
---insecure |
Accept the certificate, even if it's invalid. |
-j
--json |
Output raw JSON. |
-p [password]
--password=[password] |
The Shares user password. If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value. If you do not specify -p, the Aspera CLI prompts you for a non-echoing password. Alternatively, you can set the ASPERA_PASS environment variable. For instructions, see Installing the Aspera CLI. |
-P path
--path=path |
The remote path to the content you are renaming (with the format /share_name/relative_path_to/file_or_folder). |
-s path
--source=path |
The remote file or directory you are renaming. |
-T
port_number
--port=port_number |
The listening port on the Shares server. |
-u username
--user=username |
The Shares username. |
-v
--verbose |
Show more verbose output, for debugging. |
# aspera shares upload [args]
Arguments for the upload subcommand:
-b path
--base-ca-path=path |
The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/certs. |
-c
cookie_string
--cookie=cookie_string |
Cookie, if one is required. |
--cipher=cipher | Attempt to set the encryption cipher (if server settings allow). cipher
can be any of the following values:
|
--content-protect-password=password | Specify the password that is used to encrypt/decrypt files on the server. |
-d path
--destination=path |
Destination directory path (with the format /share_name/relative_path_to/file_or_folder). |
-e
--remove-empty-directories |
When the transfer is complete, remove empty directories. |
-E pattern
--exclude=pattern |
Exclude files that match the given pattern. To specify multiple patterns, repeat the -E option. |
-H host
--host=host |
The Shares host name. |
-i
---insecure |
Accept the certificate, even if it's invalid. |
--min-rate=new_rate | Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps. |
-o
overwrite_method
--overwrite=overwrite_method |
Overwrite existing files. overwrite_method can be any of the following values:
|
-p [password]
--password=[password] |
The Shares user password. If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value. If you do not specify -p, the Aspera CLI prompts you for a non-echoing password. Alternatively, you can set the ASPERA_PASS environment variable. For instructions, see Installing the Aspera CLI. |
-R
--remove-after-transfer |
When the transfer is complete, remove the transferred content from the source. |
--rate-policy=policy | Attempt to revise the rate policy (if server settings allow). The options for
policy are
|
-s path
--source=path |
File path to the source of the content you are uploading. |
-T
port_number
--port=port_number |
The listening port on the Shares server. |
--target-rate=newRate | Attempt to revise the target rate (if server settings allow) to a new throughput value, in kbps. |
-u username
--user=username |
The Shares username. |
-v
--verbose |
Show more verbose output, for debugging. |
-x proxy_hostOrIp
--proxy=proxy_hostOrIp |
The hostname or IP address of the proxy computer (forward proxy). |