sfz, or Static File Zerver, is a simple command-line tool serving static files for you.

The name sfz is derived from a accented note Sforzando in music, which meaning “suddenly with force.”

Features

• Directory listing
• Partial responses (range requests)
• Conditional requests with cache validations
• Cross-origin resource sharing
• Automatic HTTP compression (Brotli, Gzip, Deflate)
• Automatic rendering index.html
• Respect .gitignore file

Installation

Automatic

macOS

If you are a macOS Homebrew user, you can install sfz from a custom tap:

shell brew tap weihanglo/sfz https://github.com/weihanglo/sfz.git brew install sfz

Disclaimer: Formula on Linuxbrew did not fully tested.

Cargo

If you are a Rust programmer, sfz are available on crates.io via Cargo.

shell cargo install sfz

You can also install the latest version (or a specific commit) of sfz directly from GitHub.

shell cargo install --git https://github.com/weihanglo/sfz.git

Manual

Prebuilt binaries

Archives of prebuilt binaries are available on GitHub Release for Linux, maxOS and Windows. Download a compatible binary for your system. For convenience, make sure you place sfz under $PATH if you want access it from the command line.

Build from source

sfz is written in Rust. You need to install Rust in order to compile it.

shell $ git clone https://github.com/weihanglo/sfz.git $ cd sfz $ cargo build --release $ ./target/release/sfz --version 0.0.3

Usage

The simplest way to start serving files is to run this command:

shell sfz [FLAGS] [OPTIONS] [path]

The command above will start serving your current working directory on 0.0.0.0:5000 by default.

If you want to serve another directory, pass [path] positional argument in with either absolute or relaitve path.

```shell sfz /usr/local

Serve files under /usr/local directory.

```

Flags and Options

sfz aims to be simple but configurable. Here is a list of available options:

``` USAGE: sfz [FLAGS] [OPTIONS] [path]

FLAGS: -a, --all Serve hidden and dot (.) files -C, --cors Enable Cross-Origin Resource Sharing from any origin (*) -L, --follow-links Follow symlinks outside current serving base path -h, --help Prints help information -I, --no-ignore Don't respect gitignore file -Z, --unzipped Disable HTTP compression -V, --version Prints version information

OPTIONS: -b, --bind