tt-installer

Install the tenstorrent software stack with one command.

Quickstart

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/tenstorrent/tt-installer/refs/heads/main/install.sh)"

WARNING: Take care with this command! Always be careful running untrusted code.

Using tt-metalium

tt-installer installs tt-metalium, Tenstorrent's library for building and running AI models. Metalium is installed as a container using Podman. Using the container is easy- just run tt-metalium. By default, this will launch the container with your home directory mounted so you can access your files. You can also run tt-metalium <command> to run commands inside the container, such as tt-metalium "python3".

For more about Metalium and TTNN, check out the examples page. For more information about the container, see this page on the wiki.

Using Python Tools

tt-installer installs two Python tools on your system:

1. tt-smi: Tenstorrent's System Management Interface
2. tt-flash: Utility to update your firmware

Running tt-smi launches the interface where you can see your hardware status and confirm the install worked properly.

Full List of Functions

tt-installer performs the following actions on your system:

1. Using your package manager, installs base packages the software stack depends on
2. Configures a Python environment to install Python packages
3. Installs tenstorrent's Kernel-Mode Driver (KMD)
4. Installs tt-flash and updates your card's firmware
5. Configures HugePages, which are necessary for fast access to your Tenstorrent hardware
6. Installs tt-smi, our System Management Interface
7. Using your package manager, installs Podman
8. Installs tt-metalium as a Podman container and configures the tt-metalium script for convenient access to it

The installer will ask the user to make choices about Python environments and tt-metalium. If you wish to configure the installation more granuarly, see Advanced Usage.

Advanced Usage

Much of the installer's behavior can be configured with environment variables- some examples are shown below. For a full list of configurable parameters, please see this page on the wiki.

To install from a local file, clone this repository and run install.sh:

git clone https://github.com/tenstorrent/tt-installer.git
cd tt-installer
./install.sh

To install without prompting the user:

git clone https://github.com/tenstorrent/tt-installer.git
cd tt-installer
TT_MODE_NON_INTERACTIVE=0 ./install.sh

To install without prompting the user and automatically reboot:

git clone https://github.com/tenstorrent/tt-installer.git
cd tt-installer
TT_MODE_NON_INTERACTIVE=0 TT_REBOOT_OPTION=3 ./install.sh

Note that the installer requires superuser (sudo) permisssions to install packages, add DKMS modules, and configure hugepages.

Supported Operating Systems

Our preferred OS is Ubuntu 22.04.5 LTS (Jammy Jellyfish). Other operating systems will not be prioritized for support or features. For more information, please see this compatibility matrix:

OS	Version	Working?	Notes
Ubuntu	24.04.2 LTS	Yes	None
Ubuntu	22.04.5 LTS	Yes	None
Ubuntu	20.04.6 LTS	Yes	- Deprecated; support will be removed in a later release - Metalium cannot be installed
Debian	12.10.0	Yes	- Curl is not installed by default - The packaged rustc version is too old to complete installation, we recommend using rustup to install a more modern version
Fedora	41	Yes	May require restart after base package install
Fedora	42	Yes	May require restart after base package install
Other DEB-based distros	N/A	N/A	Unsupported but may work
Other RPM-based distros	N/A	N/A	Unsupported but may work