cryptomator / cryptomator/cli

Describe which option is required for which mounter in the usage and in the specific option

Open
#77 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
427
Forks
52
Avg merge
20h 37m
Merged PRs (30d)
2

Description

### Please agree to the following

- [X] I have searched [existing issues](https://github.com/cryptomator/cli/issues?q=) for duplicates
- [X] I agree to follow this project's [Code of Conduct](https://github.com/cryptomator/cli/blob/develop/.github/CODE_OF_CONDUCT.md)

### Summary

For a normal user it is not possible to know if e.g `loopbackHostName`, `mountOption`, `volumeName` is possible to use with e.g. `org.cryptomator.frontend.fuse.mount.LinuxFuseMountProvider`

### What software is involved?

- Operating System: Not relevant
- Cryptomator CLI: 0.6.0

### Volume Type

None

### Steps to Reproduce

1. `cryptomator-cli unlock --help`

### Expected Behavior

From within the usage, I should understand which options I need to set for which mounter. `loopbackHostName` e.g. does not make any sense together with FUSE, this should be noted in the option.

### Actual Behavior

```
Options:
-h, --help Show this help message and exit.
--loopbackHostName=
Name of the loopback address.
--loopbackPort=
Port used at the loopback address.
--maxCleartextNameLength=
Maximum cleartext filename length limit of created
files. Remark: If this limit is greater than the
shortening threshold, it does not have any effect.
-mop, --mountOption=
Additional mount option. For a list of mount options,
see the WinFsp, macFUSE, FUSE-T and libfuse
documentation.
--mounter=fully.qualified.ClassName
Name of the mounter to use
--mountPoint=/path/to/mount/point
Path to the mount point. Requirements for mount point
depend on the chosen mount service
--password:env=
Name of the environment variable containing the
passphrase
--password:file=
Path of the file containing the passphrase. The
password file must be utf-8 encoded
--password:stdin Passphrase, read from STDIN
-v, --verbose Activate verbose mode
-V, --version Print version information and exit.
--volumeId=
Id of the virtual volume.
--volumeName=
Name of the virtual volume.
```

### Reproducibility

Always

### Relevant Log Output

_No response_

### Anything else?

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.