Command-Line Interface (CLI)
The CLI is for advanced users who prefer the terminal, or who want to automate folder mapping in scripts.
Usage
rdss-folder-mapper [options] [command]Commands
| Command | Description |
|---|---|
| (default) | Refresh folder mappings (equivalent to --refresh). |
reset | Remove all existing mappings and create them fresh. |
auth | Save authentication credentials to the system keychain. |
clear-auth | Remove saved credentials from the system keychain. |
Options
| Option | Default | Description |
|---|---|---|
-V, --version | — | Print the version number and exit. |
-d, --debug | false | Enable verbose debug logging. |
-b, --base-dir <path> | ~/Desktop/RDSS Folders | Directory where folder shortcuts are created. |
-r, --host <host> | From config.json | Override the remote storage host. On macOS/Linux pair it with --volume. |
--volume <volume> | From config.json | Share/volume within the host to mount (macOS/Linux only). |
-f, --folders <path> | folders.json | Custom path to a folders JSON file. |
-t, --truncate <number> | — | Truncate folder name display to this many characters. |
--refresh | — | Force login and fetch the folder list from the DMP server even if folders.json exists. |
--force | — | Force a new login, ignoring any cached session token. |
Examples
Map folders with default settings:
bash
rdss-folder-mapperMap to a custom directory:
bash
rdss-folder-mapper --base-dir ~/Documents/ResearchReset all mappings (remove then re-create):
bash
rdss-folder-mapper resetEnable debug output:
bash
rdss-folder-mapper --debugSave credentials to the keychain:
bash
rdss-folder-mapper authConfiguration
CLI flags override values read from a config.json file placed in the working directory (next to the binary). This file is provided by your IT administrator and contains deployment-specific settings such as the remote storage path and OAuth credentials.
User preferences (base directory, debug mode) are stored separately by the Desktop GUI at:
| Platform | Path |
|---|---|
| macOS | ~/Library/Application Support/RDSS Folder Mapper/config.json |
| Windows | %APPDATA%\RDSS Folder Mapper\config.json |
| Linux | ~/.config/RDSS Folder Mapper/config.json |
Exit codes
| Code | Meaning |
|---|---|
0 | Success |
1 | Error (details printed to stderr) |