This reference documents the operations exposed by rc, the RustFS S3-compatible command-line client. The structure follows the command-reference style used by MinIO mc: each operation describes its purpose, syntax, parameters, examples, and behavior, while keeping the examples specific to rc.
For installation and quick-start usage, see the project README.
rc supports both noun-first command groups and legacy command names. Prefer the noun-first groups for new scripts:
| Operation | Preferred form | Legacy-compatible form |
|---|---|---|
| Configure targets | rc alias |
none |
| Bucket workflows | rc bucket |
rc ls, rc mb, rc rb, rc event, rc cors, rc version, rc anonymous, rc quota, rc ilm, rc replicate |
| Object workflows | rc object |
rc ls, rc cp, rc mv, rc rm, rc cat, rc head, rc stat, rc find, rc tree, rc share |
| Administrative workflows | rc admin |
none |
| Streaming upload | rc pipe |
none |
| Difference reports | rc diff |
none |
| Mirroring | rc mirror |
none |
| S3 Select | rc sql |
none |
| Tags | rc tag |
none |
| Shell completions | rc completions |
none |
Legacy command pages remain documented for users migrating from MinIO mc-style workflows:
rc lsrc mbrc rbrc catrc headrc statrc cprc mvrc rmrc findrc eventrc corsrc treerc sharerc versionrc anonymousrc quotarc ilmrc replicate
Remote paths use ALIAS/BUCKET/KEY form. An alias-only path such as local/ refers to a configured S3-compatible service. A bucket path such as local/photos refers to a bucket. An object path such as local/photos/2026/image.jpg refers to a specific object key.
Global options shown in command syntax use the same meaning everywhere:
| Option | Description |
|---|---|
--format auto|human|json |
Select automatic, human-readable, or JSON output. |
--json |
Emit JSON output where the command supports structured output. |
--no-color |
Disable terminal colors. |
--no-progress |
Disable progress bars. |
-q, --quiet |
Suppress non-error output. |
--debug |
Enable debug logging. |
-H, --header NAME:VALUE |
Add an x-amz-* header to signed S3 requests. |
Credentials are stored through aliases. Configure an alias before running remote operations:
rc alias set local http://localhost:9000 ACCESS_KEY SECRET_KEYDo not put production credentials in examples, logs, issue descriptions, or screenshots.