feat(cli-rs): add cli-rs

Author: JupiterPi

docs/cli-rs/00-readme.md

@@ -0,0 +1,12 @@
+# Filen CLI
+
+📩 [Releases](https://github.com/FilenCloudDienste/filen-cli-releases/releases) | 📖 [Documentation](https://docs.filen.io/docs/cli-rs/readme) | 📜 [Source](https://github.com/FilenCloudDienste/filen-rs/tree/main/filen-cli)
+
+This is a Rust rewrite of [FilenCloudDienste/filen-cli](https://github.com/FilenCloudDienste/filen-cli).
+
+> [!WARNING]
+> This project is in active development and still missing most functionality. **Don't use it.**
+
+This rewrite aims to improve the Filen CLI in multiple ways:
+- Significantly reduced download size from up to 130MB to ~5MB.
+- Significantly improved performance, especially startup performance, which is critical for CLI applications (because we're using Rust instead of TypeScript).

docs/cli-rs/01-usage.md

@@ -0,0 +1,25 @@
+# Usage
+
+Welcome to the Filen CLI!
+
+Invoke the Filen CLI with no command specified to enter interactive mode.
+There, you can specify absolute paths (starting with "/") or relative paths (supports "." and "..").
+
+> `help [COMMAND_OR_TOPIC]`  
+> Print help about a command or topic (default: general help)  
+> 🠊 `[COMMAND_OR_TOPIC]` Command or topic to show help about
+
+> `exit`  
+> Exit the REPL
+
+## Updates
+
+The updater checks for new releases from https://github.com/FilenCloudDienste/filen-cli-releases
+when the CLI is run (unless skipped in the 5mins since the last check, or through the `--skip-update` flag).
+The executable will be replaced in place, with the filename updated if it contains the version number.
+
+## Mounting
+
+> `mount [MOUNT_POINT]`  
+> Mount Filen as a network drive  
+> 🠊 `[MOUNT_POINT]` Where to mount the network drive (default: system default)

docs/cli-rs/02-auth.md

@@ -0,0 +1,15 @@
+# Authentication
+
+There are multiple ways to authenticate:
+- set the CLI arguments `--email` and `--password` (optionally `--two-factor-code`)
+- specify an auth config via the `--auth-config-path` flag
+  (exported) via `filen export-auth-config`
+- set environment variables (`FILEN_CLI_EMAIL` and `FILEN_CLI_PASSWORD`)
+- if none of these is set, you will be prompted for credentials
+  with the option to save them securely in the system keychain
+
+> `export-auth-config`  
+> Export an auth config (to be used with --auth-config-path option)
+
+> `logout`  
+> Delete saved credentials and exit

docs/cli-rs/03-access-files.md

@@ -0,0 +1,60 @@
+# Accessing Files
+
+> `cd <DIRECTORY>`  
+> Change the working directory (in REPL)  
+> 🠊 `<DIRECTORY>` Directory to navigate into (supports "..")
+
+> `ls [DIRECTORY]`  
+> List files in a directory  
+> 🠊 `[DIRECTORY]` Directory to list files in (default: the current working directory)
+
+> `cat <FILE>`  
+> Print the contents of a file  
+> 🠊 `<FILE>` File to print
+
+> `head [OPTIONS] <FILE>`  
+> Print the first lines of a file  
+> 🠊 `<FILE>` File to print  
+> 🠊 `-n, --lines <LINES>` Number of lines to print [default: 10]
+
+> `tail [OPTIONS] <FILE>`  
+> Print the last lines of a file  
+> 🠊 `<FILE>` File to print  
+> 🠊 `-n, --lines <LINES>` Number of lines to print [default: 10]
+
+> `stat <FILE_OR_DIRECTORY>`  
+> Show information about a file, a directory or the Filen drive  
+> 🠊 `<FILE_OR_DIRECTORY>` File or directory to show information about ("/" for the Filen drive)
+
+> `mkdir <DIRECTORY>`  
+> Create a new directory  
+> 🠊 `<DIRECTORY>` Directory to create
+
+> `rm [OPTIONS] <FILE_OR_DIRECTORY>`  
+> Remove a file or directory  
+> 🠊 `<FILE_OR_DIRECTORY>` File or directory to remove  
+> 🠊 `-p, --permanent` Permanently delete the file or directory (default: move to trash)
+
+> `mv <SOURCE> <DESTINATION>`  
+> Move a file or directory  
+> 🠊 `<SOURCE>` Source file or directory  
+> 🠊 `<DESTINATION>` Destination parent directory
+
+> `cp <SOURCE> <DESTINATION>`  
+> Copy a file or directory  
+> 🠊 `<SOURCE>` Source file or directory  
+> 🠊 `<DESTINATION>` Destination parent directory
+
+> `favorite <FILE_OR_DIRECTORY>`  
+> Favorite a file or directory  
+> 🠊 `<FILE_OR_DIRECTORY>` File or directory to favorite
+
+> `unfavorite <FILE_OR_DIRECTORY>`  
+> Unfavorite a file or directory  
+> 🠊 `<FILE_OR_DIRECTORY>` File or directory to unfavorite
+
+> `list-trash`  
+> List trashed items with option to restore or permanently delete them
+
+> `empty-trash`  
+> Permanently delete all trashed items

docs/cli-rs/_category_.json

@@ -0,0 +1,8 @@
+{
+	"label": "CLI (RS)",
+	"position": 10,
+	"link": {
+		"type": "generated-index",
+		"description": "Documentation of the Filen CLI (Rust)."
+	}
+}

docusaurus.config.ts

@@ -2,6 +2,7 @@ import { themes as prismThemes } from "prism-react-renderer"
 import { type Config } from "@docusaurus/types"
 import type * as Preset from "@docusaurus/preset-classic"
 import type * as OpenAPIPreset from "docusaurus-preset-openapi"
+import remarkGithubAdmonitionsToDirectives from "remark-github-admonitions-to-directives"
 
 const config: Config = {
 	title: "Filen Docs",
@@ -54,7 +55,8 @@ const config: Config = {
 				},
 				docs: {
 					sidebarPath: "./sidebars.ts",
-					routeBasePath: "/docs"
+					routeBasePath: "/docs",
+					beforeDefaultRemarkPlugins: [remarkGithubAdmonitionsToDirectives]
 				},
 				theme: {
 					customCss: "./src/css/custom.css"

package-lock.json

@@ -24,6 +24,7 @@
 		"prism-react-renderer": "^2.3.0",
 		"react": "^18.0.0",
 		"react-dom": "^18.0.0",
+		"remark-github-admonitions-to-directives": "^2.1.0",
 		"url": "^0.11.4"
 	},
 	"devDependencies": {

package.json

@@ -47,6 +47,13 @@ const sidebars: SidebarsConfig = {
 			type: "autogenerated",
 			dirName: "mobile"
 		}
+	],
+	// not yet released, so hiding it from the top navbar for now
+	cliRsSidebar: [
+		{
+			type: "autogenerated",
+			dirName: "cli-rs"
+		}
 	]
 }