Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/deuxfleurs-org/garage/llms.txt

Use this file to discover all available pages before exploring further.

​
Introduction

Garage provides a comprehensive command-line interface (CLI) for managing your distributed object storage cluster. The CLI allows you to perform administrative tasks such as managing nodes, configuring layouts, creating buckets, managing access keys, and running repair operations.

​
Global Options

These options apply to all Garage commands:
​
-h, --rpc-host
string
default:"from config file"
Host to connect to for admin operations, in the format: <full-node-id>@<ip>:<port>Can also be set via the GARAGE_RPC_HOST environment variable.
​
--rpc-secret
string
default:"from config file"
RPC secret for authenticationCan also be set via the GARAGE_RPC_SECRET environment variable.
​
--rpc-secret-file
string
default:"from config file"
Path to file containing the RPC secretCan also be set via the GARAGE_RPC_SECRET_FILE environment variable.
​
-c, --config
string
default:"/etc/garage.toml"
Path to the Garage configuration fileCan also be set via the GARAGE_CONFIG_FILE environment variable.

​
Command Structure

The Garage CLI follows this general pattern: 
garage [GLOBAL OPTIONS] <COMMAND> [SUBCOMMAND] [OPTIONS] [ARGUMENTS]

​
Available Commands

server

Start the Garage server process

node

Manage individual Garage nodes

layout

Configure cluster layout and node roles

bucket

Manage S3 buckets

key

Manage S3 access keys

repair

Run data repair operations

​
Additional Commands

  • garage status - Get network status of the cluster
  • garage stats - Gather node statistics
  • garage worker - Manage background workers
  • garage block - Debug operations on data blocks
  • garage meta - Operations on the metadata database
  • garage admin-token - Manage admin API tokens
  • garage offline-repair - Offline repair operations
  • garage convert-db - Convert metadata database formats

​
Environment Variables

Garage respects the following environment variables:
  • GARAGE_RPC_HOST - Default RPC host to connect to
  • GARAGE_RPC_SECRET - RPC secret for authentication
  • GARAGE_RPC_SECRET_FILE - Path to file containing RPC secret
  • GARAGE_CONFIG_FILE - Path to configuration file (default: /etc/garage.toml)
  • RUST_LOG - Configure logging verbosity (default: netapp=warn,garage=warn)
  • GARAGE_LOG_TO_SYSLOG - Enable syslog logging (set to 1 or true)
  • GARAGE_LOG_TO_JOURNALD - Enable journald logging (set to 1 or true)

​
Configuration File

By default, Garage looks for its configuration at /etc/garage.toml. You can specify a different location using the -c flag or the GARAGE_CONFIG_FILE environment variable. If both --rpc-host and --rpc-secret are provided via command-line or environment variables, Garage will not require a configuration file for administrative commands.

​
Examples

​
Using Configuration File

# Use default config file at /etc/garage.toml
garage status

# Specify custom config file
garage -c /path/to/garage.toml bucket list

​
Using Environment Variables

# Set connection details via environment
export GARAGE_RPC_HOST="1234567890abcdef@192.168.1.10:3901"
export GARAGE_RPC_SECRET="your-rpc-secret"

# Now you can run commands without a config file
garage status
garage bucket list

​
Remote Administration

# Connect to a remote Garage node
garage -h "1234567890abcdef@192.168.1.10:3901" status

# Use environment variable for remote host
export GARAGE_RPC_HOST="1234567890abcdef@192.168.1.10:3901"
garage status

​
Getting Help

For help with any command, use the --help flag: 
# General help
garage --help

# Help for a specific command
garage bucket --help

# Help for a subcommand
garage bucket create --help

Build docs developers (and LLMs) love

Get started for freeTalk to us