Feature: Refactor CLI

[infeo]

This PR refactors the CLI project completly.

The new scope of the project is to provide a compact (at best native) executable, which unlocks and mounts a single vault, following a "one mount, one process" principle. The vault can be locked & unmounted by pressing Ctrl+C in the terminal window and hitting enter (i.e., piping ETX or EOT into the process). If this process cannot be done, the process can be killed.

The password can be read from 3 sources:

• stdin
• env var
• file

The OS integration/mount is determined by the mounter. To get a list of all mounters, run the app with --mounter=none. Not all mounters are available on your system.

On the technical side, instead of a self argument parsing solution, the project relies now on picoCLI, a modern, flexible and easy-to-use CLI framework.

Remarks:

• the docker file is removed, since there is currently no lts version of openjdk > 22 available
• in branch https://github.com/cryptomator/cli/tree/feature/native-cli are some experiments with graalvm to compile to a native executable. For more infos, read the README of the branch.

[coderabbitai[bot]]

Walkthrough

The changes in this pull request encompass significant updates to the Cryptomator CLI application, affecting various components including documentation, build scripts, and core functionality. The README.md file has been revised to clarify the application's purpose, updating the command structure for unlocking vaults and specifying the minimum required Java version from JDK 17 to JDK 22. The pom.xml file reflects a comprehensive update of dependencies and build configurations, including a version bump to 1.0.0-SNAPSHOT.

New Java classes have been introduced, such as ListMounters, LoggingMixin, and PasswordSource, which enhance command-line functionality and logging management. The CryptomatorCli class has been restructured to utilize the picocli library for improved argument parsing. Additionally, new scripts for building the application on Linux, macOS, and Windows have been added, automating the creation of application binaries and Java Runtime Environments.

The module-info.java file has been updated to define module dependencies, and the LogbackConfigurator class has been introduced to manage logging configurations. Overall, these changes represent a substantial overhaul of the Cryptomator CLI, focusing on enhancing usability and maintainability.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.