Tresorit’s simple command-line interface runs on headless Linux workstations or servers. Compared to the graphical Tresorit client, it provides a limited feature set that can be used to automate tasks like sync and reporting in a way that best suits your needs.
Tresorit Linux executables
The Tresorit installer provides three executables:(the GUI), (the CLI) and (the Daemon). The runs as a daemon process. Both the GUI and the CLI can start and connect to the Daemon. If you wish, you can start the Daemon manually, or with an init script by executing the binary without any arguments.
On start, the Daemon performs autologin if it has been enabled.
When the Daemon is running, it will continue all operations it has been directed to do (synchronizing tresors, serving the Tresorit Drive, etc.) and it can automatically update itself without the need for either GUI or CLI interaction. This means that after configuring the Daemon with either the GUI or the CLI, it is sufficient to just start the Daemon on startup to automatically login and continue all sync and drive operations.
CLI - GUI interoperability
The GUI and the CLI can be used simultaneously and they will execute commands on the same Daemon instance.
If the Daemon is already running when the GUI starts (because it has been started manually or by the CLI), the GUI will connect to it, and when the GUI is closed, it will prompt you whether you want to shut the Daemon down along with it. Otherwise, if the Daemon is not yet running when you start the GUI, the GUI will automatically start it, and when the GUI is closed, it will close the Daemon without prompting you.
Using the CLI
Running the CLI
Theexecutable can be found in the client's installation path (the default is ). You can run the CLI by either changing to this directory and executing the :
Or by adding the client's installation path to yourenvironment variable and running the command. This can be done by adding
to your shell's rc (.bashrc, .zshrc, ...)
You can start the Daemon by executing
which is equivalent to starting themanually.
You can stop the Daemon by executing
which is equivalent to sending asignal ( ) to the .
If no subcommand is specified, using theoption lists all built-in subcommands.
Using theoption with a subcommand displays a help string about the subcommand and lists its options.
Normally the CLI displays lists and tables nicely formatted and padded with spaces.
If this is not desired, e.g. for scripting purposes, every command has aoption which generates easily parsable, machine-friendly output, separated by single tabs.
Tresor names and ids
When specifying a tresor, you can usually use its name. However, multiple tresors with the same name can exist. In this case, you have to use an unambiguous ID which is available in thelisting (tresors with the same name will have an ID postfixed in a format.
This is the same format that is used in Tresorit Drive for handling multiple tresors with the same name, and therefore you can also use the Tresorit Drive to find out which tresor you want to specify. Using the Tresorit Drive for this purpose has the added benefit of being able to match the tresors' name and ID with its contents.
With this command you will receive a status report on the Daemon, Tresorit Drive and if there’s an active Tresorit session.
Use this command to define the proxy settings for your Tresorit client. Depending on your network configuration, you may need to apply custom settings to succesfully login and use Tresorit.
With the login command, you can sign in to Tresorit from the command-line client, using your email, password and other authentication options you previously set up in your account.
Sign out of Tresorit with an option to unlink or even wipe synced files from the device you are using at the moment.
When you enter the list tresors command, you will receive a list of your tresors in the cloud with useful information such as their sync status and location on your computer.
Start and stop syncing
With this command, you can start or stop syncing a tresor. Tresorit will remember this setting upon restart.
Mount or unmount drive
Use this command to enable or disable Tresorit Drive on your computer. Tresorit will remember this setting upon restart.
Show sync transfers per tresor
When you enter the transfers command, you will receive a list of a tresor’s sync status: it will show if it is syncing at the moment and if so, it will include the number of files left and if are there any errors.
Log and metrics settings
Use this command to enable or disable log sending and metrics. If you encounter an issue, our support team may ask you to submit your logs to speed up the investigation.
Still have questions left? Drop us a line