CLI

Scramble CLI

Use the official Scramble Cloud command-line client to upload, download, manage, and mount encrypted files directly from your terminal.

The Scramble CLI encrypts data client-side before it leaves your machine and provides file operations, account status information, and a local WebDAV server for mounting your Scramble Drive.

Installation

Install the package globally with npm:

npm install -g @scramble-cloud/cli

After installation, the scramble-cli command is available system-wide.

Requirements

Node.js 18 or later
A valid Scramble Cloud account

Quick Start

# Log in to your Scramble Cloud account
scramble-cli login -u your@email.com

# List your files
scramble-cli ls

# Upload a file
scramble-cli upload ./document.pdf

# Download a file
scramble-cli download document.pdf -o ./downloaded.pdf

Authentication

scramble-cli login -u <username>

The password is prompted interactively and is never passed as a command-line argument.

Option	Description	Default
`-u, --username`	Username or email address. Required.	—
`-k, --insecure`	Allow self-signed SSL certificates.	`false`

If your account uses two-factor authentication, the CLI prompts for the 2FA code automatically after you enter your password.

Logout

scramble-cli logout

Session Status

scramble-cli status

Use status to check whether you are currently logged in.

Command	Description	Example
`pwd`	Print the current remote working directory.	`scramble-cli pwd`
`cd <path>`	Change the current remote directory.	`scramble-cli cd Documents`
`ls [path]`	List folder contents.	`scramble-cli ls /Photos`

The cd command supports relative paths such as ., .., and absolute paths such as /Photos/Vacation.

File Operations

Upload

scramble-cli upload ./photo.jpg
scramble-cli upload /home/user/report.pdf

Uploads a local file to the current remote directory.

Download

scramble-cli download photo.jpg
scramble-cli download photo.jpg -o ./local-copy.jpg

Option	Description
`-o, --output <path>`	Output file path. Defaults to the original filename in the current local directory.

Copy

# Copy with a new name
scramble-cli cp file.txt copy.txt

# Copy into a subfolder
scramble-cli cp file.txt /Backup/

# Copy with a new name into a subfolder
scramble-cli cp file.txt /Backup/renamed.txt

# Copy multiple files into a folder
scramble-cli cp file1.txt file2.txt /Backup/

# Copy a folder recursively
scramble-cli cp -r MyFolder MyFolder_Backup

Use -r when copying folders.

Move and Rename

# Rename a file
scramble-cli mv old-name.txt new-name.txt

# Move into a subfolder
scramble-cli mv file.txt /Archive/

# Move multiple files
scramble-cli mv file1.txt file2.txt /Archive/

# Move a folder recursively
scramble-cli mv -r MyFolder /Archive/

Use -r when moving folders.

Delete

# Delete a file
scramble-cli rm document.pdf

# Delete multiple files
scramble-cli rm file1.txt file2.txt

# Delete a folder recursively
scramble-cli rm -r OldFolder

# Delete multiple folders recursively
scramble-cli rm -r folder1 folder2

Use recursive deletion carefully. Folder deletion requires -r.

Create Folder

scramble-cli mkdir NewFolder
scramble-cli mkdir /Documents/Work/Projects

Account Information

scramble-cli info

Shows account details and storage usage, including used, available, and total storage.

WebDAV Server

The CLI can start a local WebDAV server so that you can mount your Scramble Drive as a network drive or connect it to any WebDAV-compatible client.

scramble-cli webdav

Option	Description	Default
`-p, --port <port>`	Port number.	`1900`
`--host <host>`	Hostname to bind to.	`127.0.0.1`
`-u, --username <user>`	WebDAV username.	`admin`
`--https`	Enable HTTPS with a self-signed certificate.	`false`
`--no-cache`	Disable smart cache.	—
`--auth-mode <mode>`	Authentication mode: `basic` or `digest`.	`basic`

WebDAV Password

The WebDAV password can be provided in three ways. The CLI checks them in this order:

Environment variable, recommended for automation and systemd:

SCRAMBLE_WEBDAV_PASSWORD=<password> scramble-cli webdav

Stored password, useful for desktop autostart:

scramble-cli webdav-password set
scramble-cli webdav-password clear

Interactive prompt, used when no password is configured.

Autostart with systemd on Linux

Create ~/.config/systemd/user/scramble-webdav.service:

[Unit]
Description=Scramble WebDAV Server
After=network-online.target

[Service]
ExecStart=/usr/bin/scramble-cli webdav
Restart=on-failure
RestartSec=5
EnvironmentFile=%h/.config/scramble-webdav.env

[Install]
WantedBy=default.target

Create ~/.config/scramble-webdav.env:

SCRAMBLE_WEBDAV_PASSWORD=<password>

Then secure the environment file and start the service:

chmod 600 ~/.config/scramble-webdav.env
systemctl --user enable scramble-webdav
systemctl --user start scramble-webdav

Mount with rclone

Start the WebDAV server first:

scramble-cli webdav

Then configure or mount it with rclone. See the WebDAV Rclone guide for a full setup.

License

The Scramble CLI is proprietary software. See the package license for details.