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
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
Configuration Keys
Setting | Description | Default | Supported Values |
MAX_MEMORY_CACHE_SIZE_GIGABYTES | Sets the size of Suite’s memory cache, which accounts for the majority of Suite’s memory usage. | ¼ of available system memory | Any positive integer. |
L1_DISK_CACHE_LOCATION | Full path to Suite's cache location. Should be the internal disk or external SSD. | Mac/Linux: ~/.SuiteStudios/App/Cache
Windows: ~\AppData\Local\.SuiteStudios\App\Cache | Absolute filesystem path |
L1_DISK_CACHE_SIZE_GIGABYTES | Size allocated for Suite's cache. | 250 GB | Any number greater than 10. |
L2_DISK_CACHE_LOCATION | Path to a configured Suite On-Site Cache. | null | Filesystem path |
L2_DISK_CACHE_PREFERRED_MANAGER | Sets this Suite client to manage the data transfers to the On-Site-Cache when needed. | Rotating clients |
|
MAX_UPLOAD_MEGABITS_PER_SECOND | Limits the maximum upload bandwidth Suite will use. | No limit | 10-10000 |
MAX_DOWNLOAD_MEGABITS_PER_SECOND | Limits the maximum download bandwidth Suite will use. | No limit | 50-10000 |
GROWING_FILES_ENABLED | Enables growing files feature useful for live broadcasting. | Disabled |
|
BASE_MOUNT_POINT | The location where the Suite drive will mount.
Only for Mac/Linux | Mac: /Volumes/<team-drive-name>
Linux: /mnt/<team-drive-name> | Absolute filesystem path. |
WINDOWS_DRIVE_LETTER | The drive letter to use for the Suite mount.
Takes precedence over the global team drive letter. | null | A-Z |
FUSE_ALLOW_OTHER | Only for linux. Allows all users to access the Suite drive. | false
Only the user who started the service can access the Suite drive. |
|
LOG_LEVEL | Sets Suites logging level. | debug | trace debug information warning error critical |
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!