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
| Command | Description |
|---|---|
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. |
rustfs server /data/rustfs
rustfs info --all --json
rustfs tls inspect --path /etc/rustfs/tlsLegacy invocation compatibility
Arguments are preprocessed for backward compatibility, so older invocation styles keep working:
| Legacy form | Interpreted as |
|---|---|
rustfs /data | rustfs server /data |
rustfs --address :9000 /data | rustfs server --address :9000 /data |
rustfs (no arguments) | rustfs server with volumes read from RUSTFS_VOLUMES |
rustfs --info | rustfs info |
rustfs help | rustfs --help |
Server flags
Every server flag has an environment variable equivalent; the flag wins when both are set.
| Flag | Environment variable | Default | Description |
|---|---|---|---|
<VOLUMES>... (positional) | RUSTFS_VOLUMES | required | Storage volumes or endpoints, space-separated. |
--address | RUSTFS_ADDRESS | :9000 | S3 API bind address (ADDRESS:PORT, IP or hostname). |
--server-domains | RUSTFS_SERVER_DOMAINS | unset | Comma-separated domains for virtual-hosted-style requests. |
--access-key | RUSTFS_ACCESS_KEY | unset | Root access key (conflicts with --access-key-file). |
--access-key-file | RUSTFS_ACCESS_KEY_FILE | unset | File containing the root access key. |
--secret-key | RUSTFS_SECRET_KEY | unset | Root secret key (conflicts with --secret-key-file). |
--secret-key-file | RUSTFS_SECRET_KEY_FILE | unset | File containing the root secret key. |
--console-enable | RUSTFS_CONSOLE_ENABLE | true | Enable the embedded web console. |
--console-address | RUSTFS_CONSOLE_ADDRESS | :9001 | Console bind address. |
--obs-endpoint | RUSTFS_OBS_ENDPOINT | empty | OTLP/HTTP base URL for traces, metrics, and logs. |
--tls-path | RUSTFS_TLS_PATH | unset | TLS certificate directory for the API and console. |
--license | RUSTFS_LICENSE | unset | License string. |
--region | RUSTFS_REGION | unset | Service region reported to clients. |
--kms-enable | RUSTFS_KMS_ENABLE | false | Enable KMS server-side encryption. |
--kms-backend | RUSTFS_KMS_BACKEND | local | KMS backend: local, vault / vault-kv2, vault-transit. |
--kms-key-dir | RUSTFS_KMS_KEY_DIR | unset |