Cryptomator CLI

This is a minimal command-line application that unlocks a single vault of vault format 8 and mounts it into the system.

Download and Usage

Download the zip file via GitHub Releases and unzip it to your desired directory, e.g.

curl -L https://github.com/cryptomator/cli/releases/download/0.7.0/cryptomator-cli-0.7.0-mac-arm64.zip --output cryptomator-cli.zip
unzip cryptomator-cli.zip

Afterward, you can directly run Cryptomator-CLI by calling the binary from a terminal, e.g. on Linux:

./cryptomator-cli/cryptomator-cli unlock \
--password:stdin \
--mounter=org.cryptomator.frontend.fuse.mount.LinuxFuseMountProvider \
--mountPoint=/path/to/empty/dir \
/home/user/myVault

Note

On macOS, the path to the binary is cryptomator-cli.app/Contents/MacOS/cryptomator-cli

To unmount, send a SIGTERM signal to the process, e.g. by pressing CTRL+C (macOS: CMD+C) in the terminal.

For a complete list of options, use the --help option.

cryptomator-cli --help

Filesystem Integration

To integrate the unlocked vault into the filesystem, cryptomator-cli relies on third party libraries which must be installed separately. These are:

• WinFsp for Windows
• macFUSE or FUSE-T for macOS
• and libfuse for Linux/BSD systems (normally provided by a fuse3 package of your distro, e.g. ubuntu)

As a fallback, you can skip filesystem integration by using WebDAV.

Selecting the Mounter

To list all available mounters, use the list-mounters subcommand:

cryptomator-cli list-mounters

Pick one from the printed list and use it as input for the --mounter option.

Skip Filesystem Integration

If you don't want a direct integration in the OS, choose org.cryptomator.frontend.webdav.mount.FallbackMounter for --mounter. It starts a local WebDAV server, where you can access the vault with any WebDAV client or mounting it into your filesystem manually.

Note

The WebDAV protocol is supported by all major OSses. Hence, if other mounters fail or show errors when accessing the vault content, you can always use the legacy WebDAV option. WebDAV is not the default, because it has a low performance and might have OS dependent restrictions (e.g. maximum file size of 4GB on Windows)

Windows via Windows Explorer

Open the File Explorer, right click on "This PC" and click on the menu item "Map network drive...".

1. In the Drive list, select a drive letter. (Any available letter will do.)
2. In the Folder box, enter the URL logged by the Cryptomator CLI application.
3. Select Finish.

Linux via davfs2

First, you need to create a mount point for your vault:

sudo mkdir /media/your/mounted/folder

Then you can mount the vault:

echo | sudo mount -t davfs -o username=,user,gid=1000,uid=1000 http://localhost:8080/demoVault/ /media/your/mounted/folder
# Replace gid/uid with your gid/uid. The echo is used to skip over the password query from davfs

To unmount the vault, run:

sudo umount /media/your/mounted/folder

macOS via AppleScript

Mount the vault with:

osascript -e 'mount volume "http://localhost:8080/demoVault/"'

Manual Cleanup

If a handle to a resource inside the unlocked vault is still open, a graceful unmount is not possible and cryptomator-cli just terminates without executing possible cleanup tasks. In that case the message "GRACEFUL UNMOUNT FAILED" is printed to the console/stdout.

On a linux OS with the LinuxFuseMountProvider, the manual cleanup task is to unmount and free the mountpoint:

fusermount -u /path/to/former/mountpoint

For other OSs, there is no cleanup necessary.

License

This project is dual-licensed under the AGPLv3 for FOSS projects as well as a commercial license derived from the LGPL for independent software vendors and resellers. If you want to use this library in applications, that are not licensed under the AGPL, feel free to contact our support team.