From 3f5c184e30bce33b2aa54b6a248833af10cb78f6 Mon Sep 17 00:00:00 2001 From: "Scott E. Graves" Date: Wed, 10 Sep 2025 12:49:20 -0500 Subject: [PATCH] fixed/updated options --- CLI-Usage.md | 64 ++++++++++++++++++++++++++++++---------------------- 1 file changed, 37 insertions(+), 27 deletions(-) diff --git a/CLI-Usage.md b/CLI-Usage.md index 3cb8f3e..67fc68f 100644 --- a/CLI-Usage.md +++ b/CLI-Usage.md @@ -4,37 +4,47 @@ Repertory supports multiple storage backends, each defined at mount time: -| Option | Description | -|---|---| -| `-s3`, `--s3` | Amazon S3 or S3-compatible storage. | -| `-sia`, `--sia` | Sia renterd backend. | -| `-en`, `--encrypt` | Transparent encryption provider. Read-only passthrough to a local folder or disk, decrypting both filenames and file contents with **XChaCha20-Poly1305**. | -| `-rm`, `--remote_mount` | Remote mount provider. Connects to another Repertory instance's shared mount over the network. | +| Short | Long | Description | +|---:|---|---| +| `-s3` | `--s3` | Amazon S3 or S3-compatible storage. | +| `-sia` | `--sia` | Sia renterd backend. | +| `-en` | `--encrypt` | Transparent encryption provider. Read-only passthrough to a local folder or disk, decrypting both filenames and file contents with **XChaCha20-Poly1305**. | +| `-rm` | `--remote_mount` | Remote mount provider. Connects to another Repertory instance's shared mount over the network. | --- ## 🛠 General Options -| Short | Long | Action | Description | -|---:|---|---|---| -| `-cv` | `--check_version` | check_version | Test the connected provider's backend server version to ensure it is compatible with Repertory's implementation (e.g., renterd version). | -| `-dc` | `--display_config` | display_config | Display the current configuration for the provider. | -| `-dd` | `--data_directory` | — | Specify the data directory location. | -| `-di` | `--drive_information` | drive_information | Retrieve and display drive/mount information. | -| `-gc` | `--generate_config` | — | Generate a new configuration file. | -| `-get` | `--get` | get | Get a specific configuration value by name. | -| `-gdi` | `--get_directory_items` | get_directory_items | List directory contents from the provider. | -| `-gi` | `--get_item_info` | get_item_info | Display single file or directory information. | -| `-gpf` | `--get_pinned_files` | get_pinned_files | List all pinned files. | -| `-hidden` | `--hidden` | hidden | [Windows only] Hide console window. | -| `-of` | `--open_files` | open_files | Show currently open files. | -| `-pf` | `--pin_file` | pin_file | Pin a file to keep it available locally. | -| `-ps` | `--pinned_status` | pinned_status | Show pinned status for a file. | -| `-set` | `--set` | set | Set a configuration value by name. | -| `-status` | `--status` | status | Check provider mount status. | -| `-test` | `--test` | test | Run self-tests. | -| `-unmount` | `--unmount` | unmount | Unmount the provider. | -| `-uf` | `--unpin_file` | unpin_file | Remove a pin from a file. | +| Short | Long | Description | +|---:|---|---| +| `-cv` | `--check_version` | Test the connected provider's backend server version to ensure it is compatible with Repertory's implementation (e.g., renterd version). | +| `-dc` | `--display_config` | Display the current configuration for the provider. | +| `-dd` | `--data_directory` | Specify the data directory location. | +| `-di` | `--drive_information` | Retrieve and display drive/mount information. | +| `-gc` | `--generate_config` | Generate a new configuration file. | +| `-get` | `--get` | Get a specific configuration value by name. | +| `-gdi` | `--get_directory_items` | Get directory list in json format. | +| `-gi` | `--get_item_info` | Get item information in json format. | +| `-gpf` | `--get_pinned_files` | List all pinned files. | +| `-h` | `--help` | Display help. | +| `-hidden` | `--hidden` | [Windows only] Hide console window. | +| `-of` | `--open_files` | Show currently open files. | +| `-pf` | `--pin_file` | Pin a file to keep it available locally. | +| `-ps` | `--pinned_status` | Show pinned status for a file. | +| `-set` | `--set` | Set a configuration value by name. | +| `-status` | `--status` | Check provider mount status. | +| `-test` | `--test` | Run self-tests. | +| `-unmount` | `--unmount` | Unmount the provider. | +| `-uf` | `--unpin_file` | Remove a pin from a file. | +| `-V` | `--version` | Display version information. | + +--- + +## 🛠 Required Options for Encrypt, S3, and Sia + +| Short | Long | Description | +|---:|---|---| +| `-na` | `--name` | Unique configuration name [Required]. | --- @@ -42,7 +52,7 @@ Repertory supports multiple storage backends, each defined at mount time: | Short | Long | Description | Notes | |---:|---|---|---| -| `-ui` | `--ui` | Launch the embedded GUI. | Can be combined with `--s3`, `--sia`, or `--encrypt`. | +| `-ui` | `--ui` | Launch the embedded GUI. | — | | `-lo` | `--launch_only` | Launch only the GUI without mounting. | Requires `--ui`. | | `-up` | `--ui_port` | Set the GUI port number. | Requires `--ui`. |