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, --remote-path <path> | Platform default | Network path to your institution's research storage. |
--dmp-base-url <url> | Institution default | Base URL of the Data Management Plan service. |
--refresh | — | Refresh mappings without removing existing ones first. |
--force | — | Re-create mappings even if they already exist. |
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 --debugUse a custom DMP service URL:
bash
rdss-folder-mapper --dmp-base-url https://dmp.example.eduSave credentials to the keychain:
bash
rdss-folder-mapper authConfiguration
All options can be set once via the Desktop GUI Settings panel — the CLI reads the same config file.
Config is stored 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) |