> For the complete documentation index, see [llms.txt](https://docs.zama.org/tfhe-rs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zama.org/tfhe-rs/tfhe-rs/1.3/get-started/installation.md).

# Installation

This document provides instructions to set up **TFHE-rs** in your project.

## Importing

First, add **TFHE-rs** as a dependency in your `Cargo.toml`.

```toml
tfhe = { version = "~1.3.3", features = ["boolean", "shortint", "integer"] }
```

{% hint style="info" %}
**Rust version**: a minimum Rust version of 1.81 is required to compile **TFHE-rs**.
{% endhint %}

{% hint style="success" %}
**Performance**: for optimal performance, it is highly recommended to run code that uses **`TFHE-rs`** in release mode with cargo's `--release` flag.
{% endhint %}

## Supported platforms

**TFHE-rs** currently supports the following platforms:

| OS      | x86\_64                             | aarch64     |
| ------- | ----------------------------------- | ----------- |
| Linux   | Supported                           | Supported\* |
| macOS   | Supported                           | Supported\* |
| Windows | Supported with `RDSEED` instruction | Unsupported |

By default, **TFHE-rs** makes the assumption that hardware AES features are enabled on the target CPU. The required CPU features are:

* x86\_64: sse2, aesni
* aarch64: aes, neon

To add support for older CPU, import **TFHE-rs** with the `software-prng` feature in your `Cargo.toml`:

```toml
tfhe = { version = "~1.3.3", features = ["boolean", "shortint", "integer", "software-prng"] }
```

## Hardware acceleration

**TFHE-rs** now features hardware-accelerated backends.

You can refer to the:

* [GPU backend instructions](/tfhe-rs/tfhe-rs/1.3/hardware-acceleration/run-on-gpu.md) to benefit from GPU accelerated primitives.
* [HPU backend instructions](/tfhe-rs/tfhe-rs/1.3/hardware-acceleration/run-on-hpu.md) to benefit from custom FPGA accelerated primitives.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zama.org/tfhe-rs/tfhe-rs/1.3/get-started/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.