Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 2.47 KB

README.md

File metadata and controls

97 lines (65 loc) · 2.47 KB

RustFS Homebrew Tap

English | 简体中文

This repository is the official Homebrew Tap for RustFS. RustFS is a high-performance distributed object storage software built using Rust.

Installation

You can install RustFS and RustFS-cli in several ways.

Via Homebrew (Recommended)

This is the easiest way to get started.

  1. Add the Tap:

    brew tap rustfs/homebrew-tap

  2. Install RustFS:

    brew install rustfs

  3. Install RustFS-cli:

    brew install rc

  4. Update RustFS and RustFS-cli:

    brew upgrade rustfs rc

Manual Installation

RustFS

  1. Go to the GitHub Releases page.
  2. Download the appropriate archive for your operating system and CPU architecture.
  3. Unzip the archive and move the rustfs executable to a directory in your PATH (e.g., /usr/local/bin).

RustFS-cli

  1. Go to the RustFS-cli Releases page.
  2. Download the appropriate archive for your operating system and CPU architecture.
  3. Unzip the archive and move the rc executable to a directory in your PATH (e.g., /usr/local/bin).

Usage

After installation, you can verify it and get help by running:

RustFS

# Check the version
rustfs --version

# View all available commands
rustfs --help

RustFS-cli

# Check the version
rc --version

# View all available commands
rc --help

For more detailed usage and documentation, please visit the official website: https://rustfs.com

Supported Platforms

We provide pre-compiled binaries for the following platforms:

  • macOS
    • Apple Silicon (arm64)
    • Intel (x86_64)
  • Linux
    • ARM (aarch64)
    • Intel/AMD (x86_64)

Contributing

Contributions are welcome via Issues and Pull Requests.

  • For issues related to this Homebrew Tap, please file them in this repository.
  • For issues or feature requests related to the RustFS tool itself, please file them in the main project repository.
  • For issues or feature requests related to the RustFS-cli tool, please file them in the RustFS-cli repository.
  • Before submitting a Pull Request, please ensure you follow the project's code style and contribution guidelines.

License

This project is licensed under the Apache-2.0 License.