# CLI
## Installation instructions
### Install NodeJS v20 or above (minimum required version)
1. * For Windows and MacOS the installer is here:
* For Linux distros, using built-in package managers, the instructions are here:
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 your@email.com
```
### Available commands (run filemail -h to learn more)
```
Usage: filemail [options] [command]
CLI for sending files to Filemail.com.
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
login [options] Login to Filemail API and get login token.
logout Logout from Filemail API and destroy login token.
upload [options] Upload files to Filemail.com.
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": "my@login.com",
"password": "myS3cretP4ssword",
"from": "your@email.com"
}
```
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 --help to learn more)
| Option | Description |
| ---------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `-g, --config-file ` | JSON file with configuration to apply. |
| `-b, --log-file ` | Log file to save logs to. |
| `-r, --api-retry-limit ` | Retry limit for API calls. (default: 3) |
| `-d, --log-level ` | Logging level of the file logger. (Choices: Error, Warning, Info, Debug, Trace – default: Info) |
| `--api-request-total-timeout ` | Request total timeout in milliseconds. (default: no timeout) |
| `-u, --username ` | Your username for Filemail.com. Ignored if `--logintoken` option is present. |
| `-p, --password ` | Your password for Filemail.com. If not provided and not in config file, CLI will prompt for it. |
| `-l, --logintoken ` | Authentication token from Filemail API. |
| `-t, --to ` | Recipient e-mail addresses (space separated, without quotation marks). |
| `--from ` | Sender’s e-mail address. |
| `--subject ` | Transfer subject. |
| `-m, --message ` | Transfer message. |
| `-n, --notify ` | Get email notification every time a file is downloaded. |
| `-c, --confirmation ` | Send confirmation when files have been successfully sent. |
| `-d, --days ` | Number of days files should be available to download. Defaults to account setting if not specified. |
| `--upload-password ` | Password you want to use to secure the transfer. |
| `--no-progress-bar` | Hide upload progress bar. |
| `--no-infinite-retries` | Application exits as soon as any chunk’s retry limit exceeds `--chunk-upload-retry-limit`. |
| `-k, --max-chunks-upload-in-parallel ` | Maximum number of chunks to upload simultaneously. (default: 9) |
| `--chunk-upload-retry-limit ` | Retry limit for file chunks upload. (default: 3) |
| `-e, --e2ee-key ` | End-to-end encryption key you want to use to encrypt the transfer. |
| `-x, --max-chunk-size ` | Maximum size of a single file chunk in bytes. (default: 5 MB) |
| `--upload-idle-timeout ` | Upload idle timeout in milliseconds. Time out inactive connections. (default: 90 sec) |
| `-h, --help` | Display help for command. |
The application will exit with code 0 if transfer was successful, otherwise it failed and you might want to check parameters and retry.
### Example:
This example will send 2 files (`file1.txt` and `log.log`) and a folder (`/myFolder`) to 3 recipients (`patrick@email.com`, `monica@email.com` and `john@email.com`) from the user `nicole@email.com` having set an E2EE key to `superPassword`
```
filemail upload --username nicole@email.com --e2ee-key superPassword --to patrick@email.com monica@email.com john@email.com -- c:\file1.txt c:\log.log c:\myFolder
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.filemail.com/tools/cli.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.