Skip to main content

Suite CLI

A simple guide to using the Suite Command Line Interface (CLI)

Updated this week

Starting Suite through the Command Line Interface (CLI)

Description:
Start and mount the suitefs filesystem

Usage:
suite start [options]

Options:
-u, --username <username>
Username/email to log in with

-p, --port <port>
Port to bind to - will select an available port if not specified

-d, --drive-id <drive-id>
Drive id to mount - repeat option to mount multiple drives

-?, -h, --help
Show help and usage information

ℹ You will need to set an Environment Variable on your system called SUITE_PASSWORD:

​export SUITE_PASSWORD='YOUR_PRIVATE_PASSWORD'

Here's an example that would mount multiple drives at start up:

suite start -u [email protected] -d 8fh48dfh4-9943-410f-bcb4-1f7fm4k58fn -d 8f64nnd8-9k6d-dd8d-8841-nm0ok7f5d721

CLI Commands

Usage:
suite [command] [options]

Options:
--version Show version information
-?, -h, --help Show help and usage information

Commands:
start Start and mount the suitefs filesystem
status View Suite status
stop Stop and unmount the suitefs filesystem
cache Cache commands
pre-cache Pre-Cache commands
time-machine Time machine commands
volume Volume commands - Deprecated. Use drive command instead
drive Drive commands
config Configuration commands
errors Error commands

To list the drives associated with the use. Log in as the user and to list:

 suite drive list

Config set - Options and Usage

Description:
Set a configuration entry

Usage:
suite config set [options]

Options:
-k, --key <key> (REQUIRED) Configuration key
-v, --value <value> (REQUIRED) Configuration value
-?, -h, --help Show help and usage information

Keys:
WINDOWS_DRIVE_LETTER
MAX_UPLOAD_MEGABITS_PER_SECOND
MAX_DOWNLOAD_MEGABITS_PER_SECOND

Here's an example that would set Suite's upload bandwidth limit to 1000Mbps:

suite config set -k MAX_UPLOAD_MEGABITS_PER_SECOND -v 1000 

Still have a question?

Click the chat icon in the corner of your screen to send us a message!

Did this answer your question?