diff --git a/CLI-Usage.md b/CLI-Usage.md index 67fc68f..12bc8e8 100644 --- a/CLI-Usage.md +++ b/CLI-Usage.md @@ -17,25 +17,28 @@ Repertory supports multiple storage backends, each defined at mount time: | 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). | +| `-cv` | `--check_version` | Test backend/daemon version compatibility. | | `-dc` | `--display_config` | Display the current configuration for the provider. | -| `-dd` | `--data_directory` | Specify the data directory location. | +| `-dd [directory]` | `--data_directory [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. | +| `-get [name]` | `--get [name]` | Get a specific configuration value by name. | +| `-gdi [API path]` | `--get_directory_items [API path]` | Get directory list in JSON format. | +| `-gi [API path]` | `--get_item_info [API path]` | 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. | +| `-nc` | — | Force disable console output. | +| `-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. | +| `-pf [API path]` | `--pin_file [API path]` | Pin a file to keep it available locally. | +| `-ps [API path]` | `--pinned_status [API path]` | Show pinned status for a file. | +| `-pw [password]` | `--password [password]` | Specify API password. | | `-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. | +| `-uf [API path]` | `--unpin_file [API path]` | Remove a pin from a file. | +| `-us [user]` | `--user [user]` | Specify API user name. | | `-V` | `--version` | Display version information. | --- @@ -44,7 +47,7 @@ Repertory supports multiple storage backends, each defined at mount time: | Short | Long | Description | |---:|---|---| -| `-na` | `--name` | Unique configuration name [Required]. | +| `-na [name]` | `--name [name]` | Unique configuration name [Required]. | --- @@ -54,7 +57,7 @@ Repertory supports multiple storage backends, each defined at mount time: |---:|---|---|---| | `-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`. | +| `-up [port]` | `--ui_port [port]` | Set the GUI port number. | Requires `--ui`. | ---