Command-line Client

The command-line client provides a convenient, script-friendly interface with which to upload files to TransferBigFiles.

It supports everything you’d expect; authenticating to an account, selecting files, directories and recipients, and changing transfer options such as expiry date and download notification. It will attempt to resume transfers if they fail whilst uploading, and will respect all of your upload default settings.

What transfer features does the command-line client support?

Upload entire folders.

Upload entire folders at once without having to select individual files.

20 GB uploads.

With 20 GB uploads you can have the freedom to transfer all the files you need to, and not have the hassle of compressing or consolidating beforehand.

Fault tolerant uploads.

Fault tolerant uploads are smart enough to recover from network outages so your Transfer can pick up right where it left off when things come back online.

Documentation

Examples

C:\>tbf.exe upload --email=tbf@example.com --filename=helloworld.txt

C:\>tbf.exe upload -e tbf@example.com --password=examplepassword --filename=c:\windows\*.dll --filename=*.dll

C:\>tbf.exe upload --email=tbf@example.com --filename=helloworld.txt --expires-in=30 --ignore-defaults

C:\users\you\documents\>tbf.exe upload --email=you@example.net --password=YourPassword --filename=music\*.mp3 --filename=pictures\*.jpg --recpt=familymember@example.org --recpt=friend@example.com

C:\>tbf.exe upload -e "you@example.com" -p yourpassword -f "c:\music\song.mp3" -f "tbf.exe" -r friend@example.net

Commands and Options

Currently, the only supported command is the upload command, which uploads a new transfer.

Options listed below in bold are required at least once. For optional arguments that are not provided, your profile default settings will be used in place.

Common Options

The following options are common to all available commands.

  • -e/--email Your user email address. This is required and must be valid. Anonymous uploads are not supported.
  • -p/--password Your user password. If this is not provided on the command line, it will be prompted for on stdin.
  • -b/--verbose Enables verbose status output.
  • -?/--help General help prompt. Use with a command to list all options for that command.

Upload Command

The following options are used on the upload command.

  • -f/--filename=FILENAME One filename, directory name, search pattern, or any combination thereof. Indicates a file or files that should be inclued with the upload. This option can be specified multiple times to include multiple files with the upload. See examples above for more information.
  • -r/--recpt=EMAIL One email address of a recipient. This option can be specified multiple times to include recipients of the transfer. See examples above for more information.
  • -t/--title=TITLE Set the title of the transfer.
  • -m/--message=MESSAGE Set the message of the transfer.
  • -w/--transfer-password=PASSWORD Add a password to the transfer. If this is not included, the transfer will not be password protected unless you have a default transfer password set in your user profile settings
  • -i/--expires-in=NUM Set the time in days when the transfer should expire, OR
  • -o/--expires-on=DATE Set an exact date when the transfer should expire. Dates are accepted in YYYY-MM-DD and MM/DD/YYYY format.
  • -s/--email-from-me Send email from your user email address, rather than from @transferbigfiles.com
  • -d/--notify-upon-download Notify you when your recipients download your files
  • -g/--ignore-defaults Ignore your User Profile defaults
  • -z/--zip-compression-lvl Set the amount of compression that should be used on zipped directories. 0-9. 0=No compression, 9=Maximum possible compression.