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'
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 user. Log in as the user and to list:
suite drive list
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
By default, Suite will mount the first team you joined if no drive IDs are provided.
Config set - Options and Usage
⚠️ Important: Restart Suite after each configuration change.
⚠️ Changes do not take effect until Suite has been restarted.
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
Memory and cache
MAX_MEMORY_CACHE_SIZE_GIGABYTES
Size of Suite’s memory cache, which accounts for most of Suite’s memory usage.
Default: ¼ of available system memory. Values: any positive integer.
Example: suite config set -k MAX_MEMORY_CACHE_SIZE_GIGABYTES -v 16
L1_DISK_CACHE_LOCATION
Full path to Suite’s cache. Should be the internal disk or an external SSD.
Default (Mac/Linux): ~/.SuiteStudios/App/Cache
Default (Windows): ~\AppData\Local\.SuiteStudios\App\Cache
Values: absolute filesystem path.
Example (Mac):
suite config set -k L1_DISK_CACHE_LOCATION -v /Volumes/FastSSD/SuiteCache
Example (Windows):
suite config set -k L1_DISK_CACHE_LOCATION -v D:\SuiteCache
L1_DISK_CACHE_SIZE_GIGABYTES
Size allocated for Suite’s cache.
Default: 250 GB. Values: any number greater than 10.
Example: suite config set -k L1_DISK_CACHE_SIZE_GIGABYTES -v 500
L2_DISK_CACHE_LOCATION
Path to a configured Suite On-Site Cache.
Default: null. Values: filesystem path.
Example: suite config set -k L2_DISK_CACHE_LOCATION -v /mnt/onsite-cache
L2_DISK_CACHE_PREFERRED_MANAGER
Makes this Suite client manage data transfers to the On-Site Cache when needed.
Default: rotating clients. Values: true / false.
Example: suite config set -k L2_DISK_CACHE_PREFERRED_MANAGER -v true
Bandwidth
MAX_UPLOAD_MEGABITS_PER_SECOND
Limits the maximum upload bandwidth Suite will use.
Default: no limit. Values: 10–10000.
Example: suite config set -k MAX_UPLOAD_MEGABITS_PER_SECOND -v 1000
MAX_DOWNLOAD_MEGABITS_PER_SECOND
Limits the maximum download bandwidth Suite will use.
Default: no limit. Values: 50–10000.
Example: suite config set -k MAX_DOWNLOAD_MEGABITS_PER_SECOND -v 1000
Features
GROWING_FILES_ENABLED
Enables the growing files feature, useful for live broadcasting.
Default: disabled. Values: true / false.
Example: suite config set -k GROWING_FILES_ENABLED -v true
Mounting and access
BASE_MOUNT_POINT (Mac/Linux only)
Location where the Suite drive mounts.
Default (Mac): /Volumes/<team-drive-name>
Default (Linux): /media/<team-drive-name>
Values: absolute filesystem path.
Example (Mac): suite config set -k BASE_MOUNT_POINT -v /Volumes/EditTeam
Example (Linux): suite config set -k BASE_MOUNT_POINT -v /media/edit-team
WINDOWS_DRIVE_LETTER
Drive letter used for the Suite mount. Takes precedence over the global team drive letter.
Default: null. Values: A–Z.
Example: suite config set -k WINDOWS_DRIVE_LETTER -v S
FUSE_ALLOW_OTHER (Linux only)
Allows all users to access the Suite drive.
Default: false (only the user who started the service can access it).
Values: true / false.
Example: suite config set -k FUSE_ALLOW_OTHER -v true
Logging
LOG_LEVEL
Sets Suite’s logging level.
Default: debug. Values: trace, debug, information, warning, error, critical.
Example: suite config set -k LOG_LEVEL -v warning
⚠️ If any paths you’d use contain spaces, wrap the value in quotes, for example, -v "/Volumes/Fast SSD/SuiteCache".
Still have a question?
Click the chat icon in the corner of your screen to send us a message!