Installation

There are multiple ways to install the subalfred CLI tool. Choose any one of the methods below that best suit your needs.

Pre-built Binaries

  1. Download it from the GitHub Releases page.
  2. Uncompress the downloaded file.
  3. Rename it to whatever you like. (optional)
  4. Give the execution privilege to it.

The compressing algorithm is zstd. For some systems, you might need to install zstd first. For Windows users, you would like to rename the extracted content name to subalfred.exe.

Use subalfred-aarch64-apple-darwin.zst as an example.

  • One line command:
    curl -L https://github.com/hack-ink/subalfred/releases/latest/download/subalfred-aarch64-apple-darwin.zst | zstd -o subalfred -d && chmod u+x subalfred
    
  • Multi-lines command:
    curl -LO https://github.com/hack-ink/subalfred/releases/latest/download/subalfred-aarch64-apple-darwin.zst
    zstd -o subalfred -d
    chmod u+x subalfred
    

Available pre-built binaries list.

  • subalfred-aarch64-apple-darwin.zst
  • subalfred-x86_64-apple-darwin.zst
  • subalfred-x86_64-pc-windows-msvc.zst
  • subalfred-x86_64-unknown-linux-gnu.zst

Build from Source

To build subalfred from source, you will first need to install Rust. Once you have installed Rust, the following command can be used to build and install subalfred:

  • Build from crates.io:
    cargo install subalfred
    # If you want to install the RC version.
    #
    # e.g. v0.9.0-rc18
    cargo install subalfred --version 0.9.0-rc18
    
  • Build from the latest main branch code:
    cargo install subalfred --git https://github.com/hack-ink/subalfred
    

This will automatically download subalfred from crates.io/github.com, build it, and install it in Cargo's global binary directory (~/.cargo/bin/ by default).

The version published to crates.io will ever so slightly be behind the version hosted on github.com. If you need the latest version you can build the git version of subalfred yourself. Cargo makes this super easy!

To uninstall, run the command cargo uninstall subalfred.