OS Manuals

/usr/bin/garage

S3-compatible distributed object storage service for self-hosting

From garage-2.2 2.2.0-r18 (enterprise-packages), captured 2026-11-08 by running garage --help (exit 0). permalink

garage v2.2.0 [features: bundled-libs, consul-discovery, fjall, journald, k2v, kubernetes-discovery, lmdb, metrics, sqlite, syslog, telemetry-otlp]
Structure for secret values or paths that are passed as CLI arguments or environment variables, instead of in the config
file

USAGE:
    garage [OPTIONS] <SUBCOMMAND>

FLAGS:
        --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
        --admin-token <admin-token>
            Admin API authentication token, replaces admin.admin_token in config.toml when running the Garage daemon
            [env: GARAGE_ADMIN_TOKEN=]
        --admin-token-file <admin-token-file>
            Admin API authentication token file path, replaces admin.admin_token in config.toml and admin-token when
            running the Garage daemon [env: GARAGE_ADMIN_TOKEN_FILE=]
        --allow-world-readable-secrets <allow-world-readable-secrets>
            Skip permission check on files containing secrets [env: GARAGE_ALLOW_WORLD_READABLE_SECRETS=]

    -c, --config <config-file>
            Path to configuration file [env: GARAGE_CONFIG_FILE=]  [default: /etc/garage.toml]

        --metrics-token <metrics-token>
            Metrics API authentication token, replaces admin.metrics_token in config.toml when running the Garage daemon
            [env: GARAGE_METRICS_TOKEN=]
        --metrics-token-file <metrics-token-file>
            Metrics API authentication token file path, replaces admin.metrics_token in config.toml and metrics-token
            when running the Garage daemon [env: GARAGE_METRICS_TOKEN_FILE=]
    -h, --rpc-host <rpc-host>
            Host to connect to for admin operations, in the format: <full-node-id>@<ip>:<port> [env: GARAGE_RPC_HOST=]

    -s, --rpc-secret <rpc-secret>
            RPC secret network key, used to replace rpc_secret in config.toml when running the daemon or doing admin
            operations [env: GARAGE_RPC_SECRET=]
        --rpc-secret-file <rpc-secret-file>
            RPC secret network key, used to replace rpc_secret in config.toml and rpc-secret when running the daemon or
            doing admin operations [env: GARAGE_RPC_SECRET_FILE=]

SUBCOMMANDS:
    admin-token       Operations on admin API tokens
    block             Low-level node-local debug operations on data blocks
    bucket            Operations on buckets
    convert-db        Convert metadata db between database engine formats
    help              Prints this message or the help of the given subcommand(s)
    json-api          Directly invoke the admin API using a JSON payload. The result is printed to `stdout` in JSON
                      format
    key               Operations on S3 access keys
    layout            Operations on the assignment of node roles in the cluster layout
    meta              Operations on the metadata db
    node              Operations on individual Garage nodes
    offline-repair    Offline reparation of node data (these repairs must be run offline directly on the server
                      node)
    repair            Start repair of node data on remote node
    server            Run Garage server
    stats             Gather node statistics
    status            Get network status
    worker            Manage background workers
Options (11)
OptionDescriptionSource
--helpPrints help informationhelp
-V, --versionPrints version informationhelp
--admin-token admin-tokenAdmin API authentication token, replaces admin.admin_token in config.toml when running the Garage daemon [env: GARAGE_ADMIN_TOKEN=]help
--admin-token-file admin-token-fileAdmin API authentication token file path, replaces admin.admin_token in config.toml and admin-token when running the Garage daemon [env: GARAGE_ADMIN_TOKEN_FILE=]help
--allow-world-readable-secrets allow-world-readable-secretsSkip permission check on files containing secrets [env: GARAGE_ALLOW_WORLD_READABLE_SECRETS=]help
-c, --config config-filePath to configuration file [env: GARAGE_CONFIG_FILE=] [default: /etc/garage.toml]help
--metrics-token metrics-tokenMetrics API authentication token, replaces admin.metrics_token in config.toml when running the Garage daemon [env: GARAGE_METRICS_TOKEN=]help
--metrics-token-file metrics-token-fileMetrics API authentication token file path, replaces admin.metrics_token in config.toml and metrics-token when running the Garage daemon [env: GARAGE_METRICS_TOKEN_FILE=]help
-h, --rpc-host rpc-hostHost to connect to for admin operations, in the format: <full-node-id>@<ip>:<port> [env: GARAGE_RPC_HOST=]help
-s, --rpc-secret rpc-secretRPC secret network key, used to replace rpc_secret in config.toml when running the daemon or doing admin operations [env: GARAGE_RPC_SECRET=]help
--rpc-secret-file rpc-secret-fileRPC secret network key, used to replace rpc_secret in config.toml and rpc-secret when running the daemon or doing admin operations [env: GARAGE_RPC_SECRET_FILE=]help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.