The easiest way to install ttx is using nix. As of now, the only alternative is compiling from source. In the future, a statically linked binary will available via a GitHub release. To build ttx from source, see the steps here.

Installing with Nix

Prerequisites

Install nix.
Enable the following experimental features:
- nix-command
- flakes

Run Without Installation

Using nix, its easy to run ttx directly without installing it.

nix run github:coletrammer/ttx $SHELL

Note: If the nix command fails, subsequent runs will fail as well because the result is cached by nix. To actually retry the build (and fetch the latest commit), pass the --refresh to nix:

Install Using Home Manager (recommended)

This project provides a home manager module which you can import into your own configuration. The following steps assuming your home manager configuration is managed by a flake.

Add this project as an input to your flake:

ttx = {
  url = "github:coletrammer/ttx";
 
  # Only include this if you're using nixpkgs unstable. Otherwise the default compiler will
  # be too old.
  inputs.nixpkgs.follows = "nixpkgs";
};

Import the home manager module:

imports = [
  inputs.ttx.homeModules.default
];

Enable in your configuration:

programs.ttx = {
  enable = true;
  settings = {
    prefix = "A";
    shell = lib.getExe pkgs.zsh;
  };
};

Install Directly (discouraged)

This way isn't the recommended way to use nix but works just fine.

nix profile install github:coletrammer/ttx