diff --git a/CLI-Usage.md b/CLI-Usage.md index 7feba35..61238d9 100644 --- a/CLI-Usage.md +++ b/CLI-Usage.md @@ -1 +1,94 @@ -Detailed CLI usage \ No newline at end of file +# ⚙ CLI Usage + +## 📦 Providers +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**. | + +--- + +## 🛠 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. | +| `-gpf` | `--get_pinned_files` | get_pinned_files | List all pinned files. | +| `-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. | +| `-rm` | `--remote_mount` | — | Mount a remote provider through another Repertory instance. | +| `-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. | + +--- + +## 🖥 Embedded GUI Options + +| Short | Long | Description | Notes | +|---:|---|---|---| +| `-ui` | `--ui` | Launch the embedded GUI. | Can be combined with `--s3`, `--sia`, or `--encrypt`. | +| `-lo` | `--launch_only` | Launch only the GUI without mounting. | Requires `--ui`. | +| `-up` | `--ui_port` | Set the GUI port number. | Requires `--ui`. | + +--- + +## 🔐 Authentication + +When making API calls, Repertory uses credentials from your `config.json` file. +These values are **stored unhashed**: + +```json +{ + "ApiPassword": "mysecret", + "ApiPort": 10000, + "ApiUser": "repertory" +} +``` + +- **ApiUser**: Username for API access. +- **ApiPassword**: Password for API access (will be hashed automatically for requests). +- **ApiPort**: Port number for API access. + +--- + +## 🚀 Examples + +### Mount Sia +```bash +repertory --sia --name my_sia_mount /mnt/sia +``` + +### Mount S3 +```bash +repertory --s3 --name my_s3_bucket /mnt/s3 +``` + +### Mount with Transparent Encryption +```bash +repertory --encrypt --name secure_data /mnt/secure +``` + +### Check Provider Version (renterd) +```bash +repertory --sia --check_version +``` + +### Launch Embedded GUI Only +```bash +repertory --ui --launch_only +``` + +---