Filemail CLI

This article will tell you how you can use the Filemail CLI tool

Updated over a week ago

Installation instructions

NOTE: If updating from CLI beta, run the following command:
npm install -g filemail-cli@1.0.0

Execute "filemail -V" to ensure the upgrade succeeded.

  1. Install NodeJS v16 (nodejs v14 is NOT supported)

  2. Install Filemail CLI using NPM with following command

    npm install -g filemail-cli

Test upload of a file with the CLI:

filemail upload testFile.txt -u

Available commands (run filemail -h to learn more)

Usage: filemail [options] [command]

CLI for sending files to

-V, --version output the version number
-h, --help display help for command

login [options] <username> Login to Filemail API and get login token.
logout <logintoken> Logout from Filemail API and destroy login token.
upload [options] <files...> Upload files to
help [command] display help for command

Store password and settings in a json file for safety and convenience

You can create a json config file to store your password and other settings. Thanks to this you won't need to pass them as arguments. An example json file containing username, password and from parameter value settings:

"username": "",
"password": "myS3cretP4ssword",
"from": ""

You can then use it with CLI passing it with --config-file option. For example:
โ€‹filemail upload testFile.txt --config-file "c:\filemail-config.json"

All supported upload options (run filemail upload -h to learn more)

The application will exit with code 0 if transfer was successful, otherwise it failed and you might want to check parameters and retry.

Did this answer your question?