Skip to content

Commit e779bb2

Browse files
filen-botfilen-bot
committed
update cli-rs docs for filen-cli v0.2.5
1 parent c1f4f86 commit e779bb2

3 files changed

Lines changed: 29 additions & 52 deletions

File tree

‎docs/cli-rs/00-readme.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,21 @@ For now, syncing, drive mounting, etc. are available through the managed [Filen
1717
1818
## Installation and updates
1919

20-
You can download the latest binaries from the [release page](https://github.com/FilenCloudDienste/filen-cli-releases/releases/latest).
21-
Docker images are also available as [`filen/cli`](https://hub.docker.com/repository/docker/filen/cli) (you need to specify a version instead of using `:latest`).
20+
💻 **Linux** and **macOS**:
21+
```bash
22+
curl -sL https://raw.githubusercontent.com/FilenCloudDienste/filen-rs/refs/heads/main/filen-cli/install.sh | bash
23+
```
24+
25+
💻 **Windows**: Download the latest binaries from the [release page](https://github.com/FilenCloudDienste/filen-cli-releases/releases/latest).
26+
27+
🐋 Docker images are also available as [`filen/cli`](https://hub.docker.com/repository/docker/filen/cli) (you need to specify a version instead of using `:latest`).
2228

2329
The CLI includes an automatic updater.
2430

2531
## Documentation
2632

2733
You can find documentation from within the CLI using the `help` subcommand and at [docs.filen.io](https://docs.filen.io/docs/cli-rs/readme/).
2834

29-
<!-- v0.2.4 -->
35+
<!-- v0.2.5 -->
3036

31-
<small style={{opacity: 0.5}}>Documentation for Filen CLI **v0.2.4**</small>
37+
<small style={{opacity: 0.5}}>Documentation for Filen CLI **v0.2.5**</small>

‎docs/cli-rs/01-usage.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Usage
22

3-
Welcome to Filen CLI v0.2.4!
3+
Welcome to Filen CLI v0.2.5!
44

55
Invoke the Filen CLI with no command specified to enter interactive mode (REPL).
66
There, you can specify absolute paths (starting with "/") or relative paths (supports "." and "..").
@@ -25,6 +25,8 @@ There, you can specify absolute paths (starting with "/") or relative paths (sup
2525
Skip checking for updates
2626
- `--force-update-check`
2727
Force checking for updates
28+
- `--always-update`
29+
Force checking for updates and install them automatically. Usually, updates are only installed in REPL mode
2830
- `--json`
2931
Format command output as machine-readable JSON (where applicable)
3032
- `-V, --version`

‎docs/cli-rs/04-managed-rclone.md‎

Lines changed: 16 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -7,55 +7,24 @@ It is automatically downloaded and configured (authenticated) when you run the c
77
> Execute an Rclone command using filen-rclone
88
> 🠊 `[CMD]...` The command to execute. Your Filen drive is available as the "filen" remote
99
10-
> `mount [MOUNT_POINT]`
10+
> `mount [OPTIONS] [MOUNT_POINT] [RCLONE_ARGS]...`
1111
> Mount Filen as a network drive
12-
> 🠊 `[MOUNT_POINT]` Where to mount the network drive (default: system default)
13-
14-
> `webdav [OPTIONS]`
15-
> Runs a WebDAV server exposing your Filen drive
16-
> 🠊 `--url <URL>` URL for the server (default: 127.0.0.1:8080)
17-
> 🠊 `--root <ROOT>` Directory that the server exposes (default: the entire Filen drive)
18-
> 🠊 `--user <USER>` Username for authentication to the server (default: no authentication)
19-
> 🠊 `--password <PASSWORD>` Password for authentication to the server (default: no authentication)
20-
> 🠊 `--read-only` The server is read-only
21-
22-
> `ftp [OPTIONS]`
23-
> Runs an FTP server exposing your Filen drive
24-
> 🠊 `--url <URL>` URL for the server (default: 127.0.0.1:8080)
25-
> 🠊 `--root <ROOT>` Directory that the server exposes (default: the entire Filen drive)
26-
> 🠊 `--user <USER>` Username for authentication to the server (default: no authentication)
27-
> 🠊 `--password <PASSWORD>` Password for authentication to the server (default: no authentication)
28-
> 🠊 `--read-only` The server is read-only
29-
30-
> `sftp [OPTIONS] --user <USER> --password <PASSWORD>`
31-
> Runs an SFTP server exposing your Filen drive
32-
> 🠊 `--url <URL>` URL for the server (default: 127.0.0.1:8080)
33-
> 🠊 `--root <ROOT>` Directory that the server exposes (default: the entire Filen drive)
34-
> 🠊 `--user <USER>` Username for authentication to the server
35-
> 🠊 `--password <PASSWORD>` Password for authentication to the server
36-
> 🠊 `--read-only` The server is read-only
37-
38-
> `http-server [OPTIONS]`
39-
> Runs an HTTP server exposing your Filen drive
40-
> 🠊 `--url <URL>` URL for the server (default: 127.0.0.1:8080)
12+
> 🠊 `[MOUNT_POINT]` Where to mount the network drive (default: system default)
13+
> 🠊 `[RCLONE_ARGS]...` Additional arguments to Rclone
14+
> 🠊 `--cache-size <CACHE_SIZE>` The maximum cache size (e.g. "500Mi", "10Gi") (default: calculated from available disk space)
15+
> 🠊 `--transfers <TRANSFERS>` The number of parallel transfers
16+
17+
> `serve [OPTIONS] <SERVER> [RCLONE_ARGS]...`
18+
> Runs a WebDAV, FTP, SFTP or HTTP server exposing your Filen drive
19+
> 🠊 `<SERVER>` The type of server to run: webdav, ftp, sftp, http
20+
> 🠊 `[RCLONE_ARGS]...` Additional arguments to Rclone
21+
> 🠊 `--addr <ADDRESS>` IP and port for the server ("<ip>:<port>" or ":<port>") [default: :80]
4122
> 🠊 `--root <ROOT>` Directory that the server exposes (default: the entire Filen drive)
42-
> 🠊 `--user <USER>` Username for authentication to the server (default: no authentication)
43-
> 🠊 `--password <PASSWORD>` Password for authentication to the server (default: no authentication)
44-
> 🠊 `--read-only` The server is read-only
45-
46-
> `s3 [OPTIONS]`
47-
> Runs an S3 server exposing your Filen drive
48-
> 🠊 --url <URL>
49-
> 🠊 URL for the server (default: 127.0.0.1:8080)
50-
> 🠊 --root <ROOT>
51-
> 🠊 Directory that the server exposes (default: the entire Filen drive)
52-
> 🠊 --access-key-id <ACCESS_KEY_ID>
53-
> 🠊 Access key ID for authentication to the server [default: user]
54-
> 🠊 --secret-access-key <SECRET_ACCESS_KEY>
55-
> 🠊 Secret access key for authentication to the server [default: password]
56-
> 🠊 --read-only
57-
> 🠊 The server is read-only
58-
> 🠊 Print help
23+
> 🠊 `--user <USER>` Username for authentication to the server (default: no authentication). On S3 servers, this is the Access Key ID
24+
> 🠊 `--password <PASSWORD>` Password for authentication to the server (default: no authentication). On S3 servers, this is the Secret Access Key
25+
> 🠊 `--read-only` The server is read-only
26+
> 🠊 `--cache-size <CACHE_SIZE>` The maximum cache size (e.g. "500Mi", "10Gi") (default: calculated from available disk space)
27+
> 🠊 `--transfers <TRANSFERS>` The number of parallel transfers
5928
6029
> `export-api-key`
6130
> Exports your user API key (for use with non-managed Rclone)

0 commit comments

Comments
 (0)