files Command Reference

Files Subcommands

The files command offers the following subcommands:
send send a package to a Files workspace
help view help information for a command
version print the version number of this program

For examples of Files subcommands in use, see Files Examples

The send Subcommand

Use the send subcommand to send a package. The syntax for send is as follows:
> aspera files send [args]

Arguments for the send subcommand:

--check-sshfp=fingerprint Compare fingerprint to the server SSH host key fingerprint that is set with ssh_host_key_fingerprint in aspera.conf.
--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
-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.
-f path

--file=path

The file or files to send in the package. You can specify this option multiple times, to indicate multiple files.
--fasp-proxy=proxy_hostOrIp The hostname or IP address of the proxy computer (forward proxy).
--file-checksum=hash Enable checksum reporting for transferred files.
hash is the type of checksum to calculate:
  • none (default)
  • md5
  • sha1
  • sha-256
  • sha-384
  • sha-512
--file-encrypt Encrypt files. To use this option, you must first set the encryption/decryption passphrase with the ASPERA_SCP_FILEPASS environment variable.
--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.
-lw

--lsworkspace

Get a list of the Files workspaces.
-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.
-n package_name

--name=package_name

A name for the package.
--message=body_text [Optional] Text for the body of the email message.
-o organization_name

--organization=organization_name

The name of the organization in Files that is the source of the package you are sending. Organizations are specified in the .aspera_cli_conf file.
-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.
--precalculate-job-size Precalculate the size of the transfer, for a progress bar.
-q list_file

--filelist list_file

A file that contains a list of files to transfer.

In the list_file, list the files that you want to transfer. list_file must be a plaintext file. Files must be sparated by newline characters. Paths to these files can be stated as relative to the current directory, or as absolute paths.

-r recipient

--recipient=recipient

Recipient(s) of the package. You can specify this option multiple times, to indicate multiple recipients. The recipient string should be a valid email address.
-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 address of the remote host.
--remove-empty-source-directory When the transfer is complete, remove empty source directories.
--source-prefix=prefix_path Set a path to be prepended to each source path.
--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.
-u username

--username=username

The Files username (an email address).
--user=username The username of the Aspera transfer user.
-v

--verbose

[Optional] Show more verbose output, for debugging.
-w workspace_name

--workspace=workspace_name

The Files workspace to send content to.
-X size

--rexmsg-size=size

Set the size of retransmit requests, in bytes.
-Z datagram_size

--mtu=datagram_size

Set the MTU manually, in bytes.