Command Line Interface
filesender
Usage:
Options:
--base-url TEXT The URL of the FileSender REST API
[required]
--log-level NOTSET|DEBUG|VERBOSE|INFO|FEEDBACK|WARNING|ERROR|CRITICAL
Logging verbosity [default: 25]
--version
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to
copy it or customize the installation.
download
Downloads all files associated with a transfer
Usage:
Options:
TOKEN The part of the download URL after "token=" [required]
--out-dir DIRECTORY Path to the directory to store the output files
[default:
/stornext/Home/data/allstaff/m/milton.m/FileSenderCli]
invite
Invites a user to send files to you
Usage:
Options:
--username TEXT Your username. This is the username of the
person doing the inviting, not the person
being invited. [required]
--apikey TEXT Your API token. This is the token of the
person doing the inviting, not the person
being invited. [required]
RECIPIENT The email address of the person to invite
[required]
--one-time / --no-one-time If true, this voucher is only valid for one
use, otherwise it can be re-used. [default:
one-time]
--only-to-me / --no-only-to-me If true, this voucher can only be used to
send files to you, the person who created
this voucher. Otherwise they can send files
to any email address. [default: only-to-me]
--email-upload-started / --no-email-upload-started
If true, an email will be sent to you, when
an upload to this voucher starts. [default:
no-email-upload-started]
--email-page-access / --no-email-page-access
If true, an email will be sent to you when
the guest recipient accesses the upload
page. [default: no-email-page-access]
--email-guest-created / --no-email-guest-created
If true, send an email to the guest user who
is being invited to upload. [default:
email-guest-created]
--email-receipt / --no-email-receipt
If true, send you an email when the guest
account is created. [default: email-
receipt]
--email-guest-expired / --no-email-guest-expired
If true, send you an email when the voucher
expires. [default: no-email-guest-expired]
--delay N Delay the signature timestamp by N seconds.
Increase this value if you have a slow
connection. This value should be
approximately the time it takes you to
upload one chunk to the server. [default:
0]
server-info
Prints out information about the FileSender server you are interfacing with
Usage:
upload
Sends files to an email of choice
Usage:
Options:
--username TEXT Username of the user performing the upload
[required]
--apikey TEXT API token of the user performing the upload
[required]
FILES... Files and/or directories to upload [required]
--recipients TEXT One or more email addresses to send the files
[required]
--concurrent-files INTEGER The number of files that will be uploaded
concurrently. This works multiplicatively with
`concurrent_chunks`, so `concurrent_files=2,
concurrent_chunks=2` means 4 total chunks of
data will be stored in memory and sent
concurrently. [default: 1]
--concurrent-chunks INTEGER The number of chunks that will be read from
each file concurrently. Increase this number to
speed up transfers, or reduce this number to
reduce memory usage and network errors. This
can be set to `None` to enable unlimited
concurrency, but use at your own risk.
[default: 2]
--chunk-size INTEGER The size of each chunk to read from the input
file during the upload process. Larger values
will result in a faster upload but use more
memory. If the value exceeds the server's
maximum chunk size, this command will fail.
--delay N Delay the signature timestamp by N seconds.
Increase this value if you have a slow
connection. This value should be approximately
the time it takes you to upload one chunk to
the server. [default: 0]
upload-voucher
Uploads files to a voucher that you have been invited to
Usage:
Options:
FILES... Files and/or directories to upload [required]
--guest-token TEXT The guest token. This is the part of the upload
URL after 'vid=' [required]
--email TEXT The email address that was invited to upload
files [required]
--concurrent-files INTEGER The number of files that will be uploaded
concurrently. This works multiplicatively with
`concurrent_chunks`, so `concurrent_files=2,
concurrent_chunks=2` means 4 total chunks of
data will be stored in memory and sent
concurrently. [default: 1]
--concurrent-chunks INTEGER The number of chunks that will be read from
each file concurrently. Increase this number to
speed up transfers, or reduce this number to
reduce memory usage and network errors. This
can be set to `None` to enable unlimited
concurrency, but use at your own risk.
[default: 2]
--chunk-size INTEGER The size of each chunk to read from the input
file during the upload process. Larger values
will result in a faster upload but use more
memory. If the value exceeds the server's
maximum chunk size, this command will fail.