Skip to content

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

CommandDescription
(default)Refresh folder mappings (equivalent to --refresh).
resetRemove all existing mappings and create them fresh.
authSave authentication credentials to the system keychain.
clear-authRemove saved credentials from the system keychain.

Options

OptionDefaultDescription
-V, --versionPrint the version number and exit.
-d, --debugfalseEnable verbose debug logging.
-b, --base-dir <path>~/Desktop/RDSS FoldersDirectory where folder shortcuts are created.
-r, --remote-path <path>Platform defaultNetwork path to your institution's research storage.
--dmp-base-url <url>Institution defaultBase URL of the Data Management Plan service.
--refreshRefresh mappings without removing existing ones first.
--forceRe-create mappings even if they already exist.

Examples

Map folders with default settings:

bash
rdss-folder-mapper

Map to a custom directory:

bash
rdss-folder-mapper --base-dir ~/Documents/Research

Reset all mappings (remove then re-create):

bash
rdss-folder-mapper reset

Enable debug output:

bash
rdss-folder-mapper --debug

Use a custom DMP service URL:

bash
rdss-folder-mapper --dmp-base-url https://dmp.example.edu

Save credentials to the keychain:

bash
rdss-folder-mapper auth

Configuration

All options can be set once via the Desktop GUI Settings panel — the CLI reads the same config file.

Config is stored at:

PlatformPath
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

CodeMeaning
0Success
1Error (details printed to stderr)

Released under the MIT License.