Skip to content

Commit 7bf9dc0

Browse files
authored
Update README.md
1 parent 6e45b15 commit 7bf9dc0

1 file changed

Lines changed: 23 additions & 7 deletions

File tree

README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
[![Build Status](https://travis-ci.org/cryptomator/cli.svg?branch=develop)](https://travis-ci.org/cryptomator/cli)
22
[![Latest Release](https://img.shields.io/github/release/cryptomator/cli/all.svg)](https://github.com/cryptomator/cli/releases/latest)
33

4-
# Cryptomator CLI version
4+
# Cryptomator CLI
55

6-
This is a minimal command line program which unlocks vaults, which can then be accessed via an embedded WebDAV server.
6+
This is a minimal command-line program that unlocks vaults which can then be accessed via an embedded WebDAV server.
77

88
## Disclaimer
99

1010
This project is in an early stage and not ready for production use. We recommend to use it only for testing and evaluation purposes.
1111

1212
## Download and Usage
1313

14-
Download the jar file via [GitHub Releases](https://github.com/cryptomator/cli/releases)
14+
Download the jar file via [GitHub Releases](https://github.com/cryptomator/cli/releases).
1515

16-
Cryptomator CLI depends on a Java 8 JRE. In addition the JCE unlimited strength policy files (needed for 256-bit keys) must be installed.
16+
Cryptomator CLI depends on Java 8. In addition, the JCE unlimited strength policy files must be installed (needed for 256-bit keys).
1717

1818
```sh
1919
java -jar cryptomator-cli-x.y.z.jar \
@@ -23,9 +23,11 @@ java -jar cryptomator-cli-x.y.z.jar \
2323
# you can now mount http://localhost:8080/demoVault/
2424
```
2525

26-
Then you can access the vault using any WebDAV client, e.g. using `davfs2`:
26+
Then you can access the vault using any WebDAV client.
2727

28-
First you need to create a mount point for your vault
28+
### Linux via davfs2
29+
30+
First, you need to create a mount point for your vault
2931

3032
```sh
3133
sudo mkdir /media/your/mounted/folder
@@ -37,12 +39,26 @@ Then you can mount the vault
3739
sudo mount -t davfs http://localhost:8080/demoVault/ /media/your/mounted/folder
3840
```
3941

40-
To "eject"/unmount the vault use
42+
To unmount the vault, run
4143

4244
```sh
4345
sudo umount /media/your/mounted/folder
4446
```
4547

48+
### macOS via AppleScript
49+
50+
Mount the vault with
51+
52+
```sh
53+
osascript -e 'mount volume "http://localhost:8080/demoVault/"'
54+
```
55+
56+
Unmount the vault with
57+
58+
```sh
59+
osascript -e 'tell application "Finder" to if "demoVault" exists then eject "demoVault"'
60+
```
61+
4662
## License
4763

4864
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](https://cryptomator.org/help/).

0 commit comments

Comments
 (0)