Skip to content

Commit abf7601

Browse files
Updated readme
1 parent 18e8e12 commit abf7601

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
1+
[![Build Status](https://travis-ci.org/cryptomator/cli.svg?branch=develop)](https://travis-ci.org/cryptomator/cli)
2+
13
# Cryptomator CLI version
24

35
This is a minimal command line program which unlocks vaults, which can then be accessed via an embedded WebDAV server.
46

7+
## Disclaimer
8+
9+
This project is in an early stage and not ready for production use. We recommend to use it only for testing and evaluation purposes.
10+
11+
## Download and Usage
12+
13+
Download the jar file via [GitHub Releases](https://github.com/cryptomator/cli/releases)
14+
15+
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+
17+
```sh
18+
java -jar cryptomator-cli-x.y.z.jar --port 8080 --vault demoVault=/path/to/vault --password demoVault=topSecret
19+
# you can now mount http://localhost:8080/demoVault/
20+
```
21+
22+
In the current test version passwords can only be provided as a program argument. This will change in the future.
523

624
## License
725

0 commit comments

Comments
 (0)