shares Command Reference

Shares Subcommands

The shares command offers the following 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

For examples of Shares subcommands in use, see Shares Examples

The browse Subcommand

Use the browse subcommand to see what content is on a Shares server. The syntax for browse is as follows: 
# 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.
-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:
  • type = sort directories first, then files
  • size_a = sort by file size (ascending)
  • size_d = sort by file size (descending)
  • mtime_a = sort by file modification time (ascending)
  • mtime_d = sort by file modification time (descending)
-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.
-v

--verbose

 Show more verbose output, for debugging.

The delete Subcommand

Use the delete subcommand to delete content from a Shares server. The syntax for delete is as follows: 
# 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.
-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.
-v

--verbose

 Show more verbose output, for debugging.

The download Subcommand

Use the download subcommand to download content from a Shares server. The syntax for download is as follows: 
# 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.
-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:
  • aes-128
  • aes-192
  • aes-256
  • none
-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:
  • never
  • always
  • older
  • diff
  • diff+older
-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
  • fixed
  • high
  • fair
  • low
-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.
-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).

The rename Subcommand

Use the rename subcommand to rename content on a Shares server. The syntax for rename is as follows: 
# 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.
-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.
-v

--verbose

 Show more verbose output, for debugging.

The upload Subcommand

Use the upload subcommand to upload content to a Shares server. The syntax for upload is as follows: 
# aspera shares upload [args]

Arguments for the upload 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.
-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:
  • aes-128
  • aes-192
  • aes-256
  • none
-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.
--fasp-proxy=proxy_hostOrIp The hostname or IP address of the proxy computer (forward proxy).
--file-encrypt Encrypt files. To use this option, you must first set the encryption/decryption passphrase with the ASPERA_SCP_FILEPASS environment variable.
-H host

--host=host

 The Shares host name.
-i

--insecure

 Accept the certificate, even if it's invalid.
--ignore-host-key Ignore the server's SSH host key fingerprint.
-j

--encode-jpeg

 Encode all HTTP transfers as JPEG files.
-k resume_level

--resume-level=resume_level

 Enable the resuming of partially transferred files at the specified resume level.
resume_level can have the following values:
  • 0 (default) - Always retransfer the entire file.
  • 1 - Compare file attributes and resume if they match, and retransfer if they do not.
  • 2 - Compare file attributes and the sparse file checksums; resume if they match, and retransfer if they do not.
  • 3 - Compare file attributes and the full file checksums; resume if they match, and retransfer if they do not.
-l new_rate

--target-rate=new_rate

 Attempt to revise the target rate (if server settings allow) to a new throughput value, in kbps.
-L path

--log-path=path

 The path to the logfile.
-m new_rate

--min-rate=new_rate

 Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps.
--move-after-transfer=path Specify the directory where the file will be moved to after it is transferred.
-o overwrite_method

--overwrite=overwrite_method

 Overwrite existing files. overwrite_method can be any of the following values:
  • never
  • always
  • older
  • diff
  • diff+older
-O port_num

--udp-port=port_num

 Set the UDP port for FASP transfers.
--preserve-dates Preserve the timestamps on transferred files.
-P port_num

--tcp-port=port_num

 Set the TCP port for FASP transfers.
--partial-file-suffix=suffix 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 The listening port on the Shares server.
-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
  • fixed
  • high
  • fair
  • low
--remote-host=host_address The remote host address.
--remove-empty-source-directory 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 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 Strip the specified prefix from each source path. The remaining portion of the source path is kept intact at the destination.
-T

--disable-encryption

 Disable encryption.
--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.
-v

--verbose

 Show more verbose output, for debugging.
-Z datagram_size

--mtu=datagram_size

 Set the MTU manually, in bytes.