Skip to main content
Suite CLI

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

Updated over a week ago

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 login with

-p, --port <port> Option explicit port to bind to

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

Prior to running this command or inline you'll need to set an Environment Variable on your system called SUITE_PASSWORD. Ex:

SUITE_PASSWORD='replace_me_with_password' suite start --username replace_me_with_username

CLI Commands

Usage:

suite [command] [options]
​

Options:

--version Show version information

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

Commands:

status View Suite status

start Start and mount the suitefs filesystem

stop Stop and unmount the suitefs filesystem

volume Volume commands

pre-cache Pre-Cache commands

cache Cache commands

time-machine Time machine commands

config set Set Advanced configuration options

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?