shares Command Reference
Shares Subcommands
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 |
The browse Subcommand
# aspera shares browse [args]
Arguments for the browse subcommand:
Option | Definition |
---|---|
-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/etc.
Note: The Aspera CLI installer places a certificates
bundle at installation-dir/etc/curl-ca-bundle.crt. Use this argument
if you want to provide a different certificate location. |
-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
--username username |
The Shares username. |
--user username | The username of the Aspera transfer user. |
The delete Subcommand
# aspera shares delete [args]
Arguments for the delete subcommand:
Option | Definition |
---|---|
-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/etc.
Note: The Aspera CLI installer places a certificates
bundle at installation-dir/etc/curl-ca-bundle.crt. Use this argument
if you want to provide a different certificate location. |
-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
--username username |
The Shares username. |
--user username | The username of the Aspera transfer user. |
The download Subcommand
# aspera shares download [args]
Arguments for the download subcommand:
Option | Definition |
---|---|
-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/etc.
Note: The Aspera CLI installer places a certificates
bundle at installation-dir/etc/curl-ca-bundle.crt. Use this argument
if you want to provide a different certificate location. |
-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 have the following values:
|
-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:
|
-O
port_num
--udp-port port_num |
[Optional] Set the UDP port for FASP transfers. |
-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
port_num
--tcp-port port_num |
[Optional] Set the TCP port for FASP transfers. |
--preserve-dates | [Optional] Preserve the timestamps on transferred files. |
-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
--username username |
The Shares username. |
--user username | The username of the Aspera transfer user. |
-x
proxy_hostOrIp
--proxy proxy_hostOrIp |
The hostname or IP address of the proxy computer (forward proxy). |
The rename Subcommand
# aspera shares rename [args]
Arguments for the rename subcommand:
Option | Definition |
---|---|
-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/etc.
Note: The Aspera CLI installer places a certificates
bundle at installation-dir/etc/curl-ca-bundle.crt. Use this argument
if you want to provide a different certificate location. |
-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
--username username |
The Shares username. |
--user username | The username of the Aspera transfer user. |
The upload Subcommand
# aspera shares upload [args]
Arguments for the upload subcommand:
Option | Definition |
---|---|
-b
path
--base-ca-path path |
[Optional] 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/etc. Note: The Aspera CLI installer places a certificates
bundle at installation-dir/etc/curl-ca-bundle.crt. Use this argument
if you want to provide a different certificate location. |
-c
cookie_string
--cookie cookie_string |
[Optional] Cookie, if one is required. |
--cipher cipher | [Optional] Attempt to set the encryption cipher (if server settings allow).
cipher can have the following values:
|
-d
path
--destination path |
Destination directory path (with the format /share_name/relative_path_to/file_or_folder). |
-e
--remove-empty-directories |
[Optional] When the transfer is complete, remove empty directories. |
-E
pattern
--exclude pattern |
[Optional] Exclude files that match the given pattern. To specify multiple patterns, repeat the -E option. |
--fasp-proxy proxy_hostOrIp | [Optional] The hostname or IP address of the proxy computer (forward proxy). |
--file-encrypt | [Optional] Encrypt files. To use this option, you must first set the ASPERA_SCP_FILEPASS environment variable with the encryption/decryption passphrase. |
-H
host
--host host |
The Shares host name. |
-i
--insecure |
[Optional] Accept the certificate, even if it's invalid. |
--ignore-host-key | [Optional] Ignore the server's SSH host key fingerprint. |
-j
--encode-jpeg |
[Optional] Encode all HTTP transfers as JPEG files. |
-k
resume_level
--resume-level resume_level |
[Optional] Enable the resuming of partially transferred files at the specified
resume level. resume_level can have the following values:
|
-l
new_rate
--target-rate new_rate |
[Optional] Attempt to revise the target rate (if server settings allow) to a new throughput value, in kbps. |
-L
path
--log-path path |
[Optional] The path to the logfile. |
-m
new_rate
--min-rate new_rate |
[Optional] Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps. |
--move-after-transfer path | [Optional] Specify the directory where the file will be moved to after it is transferred. |
-o
overwrite_method
--overwrite overwrite_method |
[Optional] Overwrite existing files. overwrite_method can be any of the
following values:
|
-O
port_num
--udp-port port_num |
[Optional] Set the UDP port for FASP transfers. |
--preserve-dates | [Optional] Preserve the timestamps on transferred files. |
-P
port_num
--tcp-port port_num |
[Optional] Set the TCP port for FASP transfers. |
--partial-file-suffix suffix | [Optional] Set a suffix to append to the filenames of partially transferred files. |
-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. |
--port port_number | [Optional] The listening port on the Shares server. |
-q, --filelist | [Optional] Specify a file that contains a list of files to transfer. |
-R
--remove-after-transfer |
[Optional] When the transfer is complete, remove the transferred content from the source. |
--rate-policy policy | [Optional] Attempt to revise the rate policy (if server settings allow). The
options for policy are
|
--remote-host host_address | [Optional] The remote host address. |
--remove-empty-source-directory | [Optional] When the transfer is complete, remove empty source directories. |
-s
path
--source path |
File path to the source of the content you are uploading. |
--save-before-overwrite | [Optional] Save a copy of a file before it is overwritten by the transfer. A copy of filename.ext is saved as filename.yyyy.mm.dd.hh.mm.ss.index.ext in the same directory. |
--src-base prefix | [Optional] Strip the specified prefix from each source path. The remaining portion of the source path is kept intact at the destination. |
-T
--disable-encryption |
[Optional] Disable encryption. |
--target-rate newRate | [Optional] Attempt to revise the target rate (if server settings allow) to a new throughput value, in kbps. |
-u
username
--username username |
The Shares username. |
--user username | [Optional] The username of the Aspera transfer user. |
-Z
datagram_size
--mtu datagram_size |
[Optional] Set the MTU manually, in bytes. |