CLI Reference

Reference for the rustfs subcommands, server flags, environment variable equivalents, and volume path syntax.

The rustfs binary ships six subcommands. Running rustfs with no subcommand starts the server.

Subcommands

CommandDescription
rustfs server [OPTIONS] <VOLUMES>...Start the object storage server (default when no subcommand is given).
rustfs info [--all] [--json] [system|runtime|build|config|deps]Display system, runtime, build, configuration, or dependency information.
rustfs tls inspect --path <DIR>Inspect a TLS certificate directory layout and parsing status.
rustfs diagnose [OPTIONS] <PATHS>...Analyze log files and report probable failure causes.
rustfs inspect <COMMAND>Inspect persisted bucket metadata without a running server.
rustfs connect <COMMAND>Configure outbound RustFS Connect integration.
Examples
rustfs server /data/rustfs
rustfs info --all --json
rustfs tls inspect --path /etc/rustfs/tls

Legacy invocation compatibility

Arguments are preprocessed for backward compatibility, so older invocation styles keep working:

Legacy formInterpreted as
rustfs /datarustfs server /data
rustfs --address :9000 /datarustfs server --address :9000 /data
rustfs (no arguments)rustfs server with volumes read from RUSTFS_VOLUMES
rustfs --inforustfs info
rustfs helprustfs --help

Server flags

Every server flag has an environment variable equivalent; the flag wins when both are set.

FlagEnvironment variableDefaultDescription
<VOLUMES>... (positional)RUSTFS_VOLUMESrequiredStorage volumes or endpoints, space-separated.
--addressRUSTFS_ADDRESS:9000S3 API bind address (ADDRESS:PORT, IP or hostname).
--server-domainsRUSTFS_SERVER_DOMAINSunsetComma-separated domains for virtual-hosted-style requests.
--access-keyRUSTFS_ACCESS_KEYunsetRoot access key (conflicts with --access-key-file).
--access-key-fileRUSTFS_ACCESS_KEY_FILEunsetFile containing the root access key.
--secret-keyRUSTFS_SECRET_KEYunsetRoot secret key (conflicts with --secret-key-file).
--secret-key-fileRUSTFS_SECRET_KEY_FILEunsetFile containing the root secret key.
--console-enableRUSTFS_CONSOLE_ENABLEtrueEnable the embedded web console.
--console-addressRUSTFS_CONSOLE_ADDRESS:9001Console bind address.
--obs-endpointRUSTFS_OBS_ENDPOINTemptyOTLP/HTTP base URL for traces, metrics, and logs.
--tls-pathRUSTFS_TLS_PATHunsetTLS certificate directory for the API and console.
--licenseRUSTFS_LICENSEunsetLicense string.
--regionRUSTFS_REGIONunsetService region reported to clients.
--kms-enableRUSTFS_KMS_ENABLEfalseEnable KMS server-side encryption.
--kms-backendRUSTFS_KMS_BACKENDlocalKMS backend: local, vault / vault-kv2, vault-transit.
--kms-key-dirRUSTFS_KMS_KEY_DIRunset