sidebar_label	sidebar_position	slug
Command Reference	1	/command_reference

Command Reference

There are many commands to help you manage your file system. This page provides a detailed reference for these commands.

Overview

If you run juicefs by itself, it will print all available commands. In addition, you can add -h/--help flag after each command to get more information of it, e.g., juicefs format -h.

$ juicefs -h
NAME:
   juicefs - A POSIX file system built on Redis and object storage.

USAGE:
   juicefs [global options] command [command options] [arguments...]

VERSION:
   1.0-dev (2021-12-27 3462bdbf)

COMMANDS:
   format   format a volume
   mount    mount a volume
   umount   unmount a volume
   gateway  S3-compatible gateway
   sync     sync between two storage
   rmr      remove directories recursively
   info     show internal information for paths or inodes
   bench    run benchmark to read/write/stat big/small files
   gc       collect any leaked objects
   fsck     Check consistency of file system
   profile  analyze access log
   stats    show runtime statistics
   status   show status of JuiceFS
   warmup   build cache for target directories/files
   dump     dump metadata into a JSON file
   load     load metadata from a previously dumped JSON file
   config   change config of a volume
   destroy  destroy an existing volume
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --verbose, --debug, -v  enable debug log (default: false)
   --quiet, -q             only warning and errors (default: false)
   --trace                 enable trace log (default: false)
   --no-agent              Disable pprof (:6060) and gops (:6070) agent (default: false)
   --help, -h              show help (default: false)
   --version, -V           print only the version (default: false)

COPYRIGHT:
   Apache License 2.0

:::note If juicefs is not placed in your $PATH, you should run the script with the path to the script. For example, if juicefs is in current directory, you should use ./juicefs. It is recommended to place juicefs in your $PATH for convenience. You can refer to Installation & Upgrade for more information. :::

:::note If the command option is of boolean type, such as --debug, there is no need to set any value, just add --debug to the command to enable the function; this function is disabled if --debug is not added. :::

Auto Completion

:::note This feature requires JuiceFS >= 0.15.2. It is implemented based on github.com/urfave/cli/v2. You can find more information here. :::

To enable commands completion, simply source the script provided within hack/autocomplete. For example:

Bash:

source hack/autocomplete/bash_autocomplete

Zsh:

source hack/autocomplete/zsh_autocomplete

Please note the auto-completion is only enabled for the current session. If you want to apply it for all new sessions, add the source command to .bashrc or .zshrc:

echo "source path/to/bash_autocomplete" >> ~/.bashrc

or

echo "source path/to/zsh_autocomplete" >> ~/.zshrc

Alternatively, if you are using bash on a Linux system, you may just copy the script to /etc/bash_completion.d and rename it to juicefs:

sudo cp hack/autocomplete/bash_autocomplete /etc/bash_completion.d/juicefs

source /etc/bash_completion.d/juicefs

Commands

juicefs format

Description

Format a volume. It's the first step for initializing a new file system volume.

Synopsis

juicefs format [command options] META-URL NAME

META-URL: Database URL for metadata storage, see "JuiceFS supported metadata engines" for details.
NAME: the name of the file system

Options

--block-size value
size of block in KiB (default: 4096)

--capacity value
the limit for space in GiB (default: unlimited)

--inodes value
the limit for number of inodes (default: unlimited)

--compress value
compression algorithm (lz4, zstd, none) (default: "none")

--shards value
store the blocks into N buckets by hash of key (default: 0)

--storage value
Object storage type (e.g. s3, gcs, oss, cos) (default: "file")

--bucket value
A bucket URL to store data (default: "$HOME/.juicefs/local" or "/var/jfs")

--access-key value
Access key for object storage (env ACCESS_KEY)

--secret-key value
Secret key for object storage (env SECRET_KEY)

--encrypt-rsa-key value
A path to RSA private key (PEM)

--trash-days value
number of days after which removed files will be permanently deleted (default: 1)

--force
overwrite existing format (default: false)

--no-update
don't update existing volume (default: false)

juicefs mount

Description

Mount a volume. The volume shoud be formatted first.

Synopsis

juicefs mount [command options] META-URL MOUNTPOINT

META-URL: Database URL for metadata storage, see "JuiceFS supported metadata engines" for details.
MOUNTPOINT: file system mount point, e.g. /mnt/jfs, Z:.

Options

--metrics value
address to export metrics (default: "127.0.0.1:9567")

--consul value
consul address to register (default: "127.0.0.1:8500")

--no-usage-report
do not send usage report (default: false)

-d, --background
run in background (default: false)

--no-syslog
disable syslog (default: false)

--log value
path of log file when running in background (default: $HOME/.juicefs/juicefs.log or /var/log/juicefs.log)

-o value
other FUSE options (see this document for more information)

--attr-cache value
attributes cache timeout in seconds (default: 1)

--entry-cache value
file entry cache timeout in seconds (default: 1)

--dir-entry-cache value
dir entry cache timeout in seconds (default: 1)

--enable-xattr
enable extended attributes (xattr) (default: false)

--bucket value
customized endpoint to access object storage

--get-timeout value
the max number of seconds to download an object (default: 60)

--put-timeout value
the max number of seconds to upload an object (default: 60)

--io-retries value
number of retries after network failure (default: 10)

--max-uploads value
number of connections to upload (default: 20)

--max-deletes value
number of threads to delete objects (default: 2)

--buffer-size value
total read/write buffering in MiB (default: 300)

--upload-limit value
bandwidth limit for upload in Mbps (default: 0)

--download-limit value
bandwidth limit for download in Mbps (default: 0)

--prefetch value
prefetch N blocks in parallel (default: 1)

--writeback
upload objects in background (default: false)

--cache-dir value
directory paths of local cache, use colon to separate multiple paths (default: "$HOME/.juicefs/cache" or "/var/jfsCache")

--cache-size value
size of cached objects in MiB (default: 102400)

--free-space-ratio value
min free space (ratio) (default: 0.1)

--cache-partial-only
cache random/small read only (default: false)

--read-only
allow lookup/read operations only (default: false)

--open-cache value
open file cache timeout in seconds (0 means disable this feature) (default: 0)

--subdir value
mount a sub-directory as root (default: "")

juicefs umount

Description

Unmount a volume.

Synopsis

juicefs umount [command options] MOUNTPOINT

Options

-f, --force
force unmount a busy mount point (default: false)

juicefs gateway

Description

Start an S3-compatible gateway.

Synopsis

juicefs gateway [command options] META-URL ADDRESS

META-URL: Database URL for metadata storage, see "JuiceFS supported metadata engines" for details.
ADDRESS: S3 gateway address and listening port, for example: localhost:9000

Options

--bucket value
customized endpoint to access an object storage