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, --host <host>From config.jsonOverride the remote storage host. On macOS/Linux pair it with --volume.
--volume <volume>From config.jsonShare/volume within the host to mount (macOS/Linux only).
-f, --folders <path>folders.jsonCustom path to a folders JSON file.
-t, --truncate <number>Truncate folder name display to this many characters.
--refreshForce login and fetch the folder list from the DMP server even if folders.json exists.
--forceForce a new login, ignoring any cached session token.

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

Save credentials to the keychain:

bash
rdss-folder-mapper auth

Configuration

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:

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.