Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

There are multiple ways to install btdt. Choose the method from below that best fits your needs.

Note

Currently, only Unix (Linux, macOS) systems are supported.

Pre-compiled binaries

You can download pre-compiled binaries from the GitHub Releases page (look for btdt-cli releases). The archive contains a single executable binary btdt. You might want to place it in your $PATH for easy access.

For Linux, you have the choice between a version depending on a suffciently recent glibc version (-gnu suffix) and a statically linked version (-musl suffix) that should work on most systems, even without glibc.

Docker images

Docker images are available on Docker Hub. This allows to directly run btdt without installing it on your system:

docker run jgosmann/btdt btdt --help

However, you will have to mount the directories with the cache and the files to cache into the container. This can be done with the --mount or --volume option.

The images use Semantic Versioning tags. For example, jgosmann/btdt:0.1 refers to the latest v0.1.x image.

Build from source using Rust

If you have Rust installed, you can build btdt from source using cargo:

cargo install btdt