Skip to content

Installation

Zeqian Li edited this page Aug 1, 2025 · 17 revisions

Stable release

cargo

Prerequisite: rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Add Rust to your path (or restart your terminal):
source "$HOME/.cargo/env"

Install:

cargo install tgv

homebrew

brew tap zeqianli/tgv
brew install tgv

# Test
tgv

You will see a warning message on MacOS:

Apple could not verify "tgv" is free of malware that may harm your Mac or compromise your privacy.

This is because the binary is not yet signed with an Apple developer account that costs $99/year. I may do this one day. Don't worry, the program is open-source and safe :)

To continue, modify the Privacy & Security setting: https://support.apple.com/en-us/102445

Bioconda

Set up bioconda if you haven't: https://bioconda.github.io/

conda install bioconda::tgv

Pre-built binaries

Pre-built binaries are found in Github Releases. They are not tested on all operating system. Please report issues or try another installation method.

Optional: Add to the system PATH:

# Pick a version at the release page
VERSION=____

# Linux: tgv-x86_64-linux-musl.tar.gz; MacOS: tgv-aarch64-apple-darwin.tar.gz 
FILENAME=____ 

curl -L https://github.com/zeqianli/tgv/releases/download/${VERSION}/${FILENAME}
tar -xzf tgv-aarch64-apple-darwin.tar.gz
sudo mv tgv /usr/local/bin/

# test
tgv --version

Similarly, MacOS would raise a warning here. See the solution above.

conda

TODO

Nix

TODO

Latest development branch

git clone https://github.com/zeqianli/tgv.git
cd tgv

# Rust is required
cargo install --path .

Build troubleshoot

When building from source / installing through cargo install, c compiler error is common:

error: linking with `cc` failed: exit status: 1

# or
Unable to find libclang: "the `libclang` shared library at ... could not be opened

Try installing the developer toolkits before building.

  • Linux

    sudo apt install build-essential libclang-dev
  • MacOS

    1. Upgrade the operating system. Some people have internet connection issue (with reqwest) with older systems.
    2. Install Xcode command line tools:
    xcode-select --install
    # Proceed in the pop-up window

Clone this wiki locally