OS Manuals

/usr/bin/weed

SeaweedFS is a fast distributed storage system for blobs, objects, files.

From seaweedfs 4.32-r0 (os), captured 2026-11-05 by running weed --help (exit 2). permalink

SeaweedFS: store billions of files and serve them fast!

Usage:

	weed command [arguments]

The commands are:

    admin       start SeaweedFS web admin interface
    autocomplete generate or install shell autocomplete script
    autocomplete.uninstall uninstall autocomplete
    backup      incrementally backup a volume to local folder
    benchmark   benchmark by writing millions of files and reading them out
    compact     run weed tool compact on volume file
    download    download files by file id
    export      list or export files from one volume data file
    filer       start a file server that points to a master server, or a list of master servers
    filer.backup resume-able continuously replicate files from a SeaweedFS cluster to another location defined in replication.toml
    filer.cat   copy one file to local
    filer.copy  copy one or a list of files to a filer folder
    filer.meta.backup continuously backup filer meta data changes to anther filer store specified in a backup_filer.toml
    filer.meta.tail see continuous changes on a filer
    filer.remote.gateway resumable continuously write back bucket creation, deletion, and other local updates to remote object store
    filer.remote.sync resumable continuously write back updates to remote storage
    filer.replicate replicate file changes to another destination
    filer.sync  resumable continuous synchronization between two active-active or active-passive SeaweedFS clusters
    filer.sync.verify compare entries between two filers and report differences
    fix         run weed tool fix on files or whole folders to recreate index file(s) if corrupted
    fuse        Allow use weed with linux's mount command
    iam         [DEPRECATED] start a standalone iam API compatible server
    master      start a master server
    master.follower start a master follower
    mini        start a complete SeaweedFS setup optimized for S3 beginners and small/dev use cases
    mount       mount weed filer to a directory as file system in userspace(FUSE)
    mq.agent    <WIP> start a message queue agent
    mq.broker   <WIP> start a message queue broker
    mq.kafka.gateway start a Kafka wire-protocol gateway for SeaweedMQ with schema management
    s3          start a s3 API compatible server that is backed by filer(s)
    scaffold    generate basic configuration files
    server      start a master server, a volume server, and optionally a filer and a S3 gateway
    shell       run interactive administrative commands
    update      get latest or specific version from https://github.com/seaweedfs/seaweedfs
    upload      upload one or a list of files
    version     print SeaweedFS version
    volume      start a volume server
    webdav      start a webdav server that is backed by a filer
    sftp        start an SFTP server that is backed by a SeaweedFS filer
    worker      start a plugin.proto worker process

Use "weed help [command]" for more information about a command.

For Logging, use "weed [logging_options] [command]". The logging options are:
  -alsologtostderr
    	log to standard error as well as files (default true)
  -config_dir value
    	directory with toml configuration files
  -log_backtrace_at value
    	when logging hits line file:N, emit a stack trace
  -log_compress
    	Gzip-compress rotated log files to save disk space
  -log_json
    	Output logs in JSON format instead of glog text format
  -log_max_files int
    	Maximum number of log files to keep per severity level before older ones are deleted (0 = use default of 5) (default 5)
  -log_max_size_mb uint
    	Maximum size in megabytes of each log file before it is rotated (0 = use default of 1800 MB) (default 1800)
  -log_rotate_hours int
    	Rotate log files after this many hours (default: 168 = 7 days, 0 = disabled) (default 168)
  -logdir string
    	If non-empty, write log files in this directory
  -logtostderr
    	log to standard error instead of files
  -options string
    	a file of command line options, each line in optionName=optionValue format
  -stderrthreshold value
    	logs at or above this threshold go to stderr
  -v value
    	log levels [0|1|2|3|4], default to 0
  -vmodule value
    	comma-separated list of pattern=N settings for file-filtered logging
Options (14)
OptionDescriptionSource
-alsologtostderrlog to standard error as well as files (default true)help
-config_dir valuedirectory with toml configuration fileshelp
-log_backtrace_at valuewhen logging hits line file:N, emit a stack tracehelp
-log_compressGzip-compress rotated log files to save disk spacehelp
-log_jsonOutput logs in JSON format instead of glog text formathelp
-log_max_files intMaximum number of log files to keep per severity level before older ones are deleted (0 = use default of 5) (default 5)help
-log_max_size_mb uintMaximum size in megabytes of each log file before it is rotated (0 = use default of 1800 MB) (default 1800)help
-log_rotate_hours intRotate log files after this many hours (default: 168 = 7 days, 0 = disabled) (default 168)help
-logdir stringIf non-empty, write log files in this directoryhelp
-logtostderrlog to standard error instead of fileshelp
-options stringa file of command line options, each line in optionName=optionValue formathelp
-stderrthreshold valuelogs at or above this threshold go to stderrhelp
-v valuelog levels [0|1|2|3|4], default to 0help
-vmodule valuecomma-separated list of pattern=N settings for file-filtered logginghelp

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