> 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/0.8/readme.md).

# Welcome to TFHE-rs

TFHE-rs is a pure Rust implementation of TFHE for Boolean and integer arithmetics over encrypted data. It includes a Rust and C API, as well as a client-side WASM API.

## Get started

Learn the basics of TFHE-rs, set it up, and make it run with ease.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>What is TFHE-rs?</strong></td><td>Understand TFHE-rs library and basic cryptographic concepts</td><td><a href="/tfhe-rs/tfhe-rs/0.8/get-started/getting_started.md">What is TFHE-rs?</a></td><td><a href="https://1380833884-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa2Y94auFuxArnQG5CF2x%2Fuploads%2Fgit-blob-ef8d6303f852601e203cdfd9fa6bbdd4a47d8c96%2Fstart1.png?alt=media">start1.png</a></td></tr><tr><td><strong>Installation</strong></td><td>Follow the step by step guide to import TFHE-rs in your project</td><td><a href="/tfhe-rs/tfhe-rs/0.8/get-started/installation.md">Installation</a></td><td><a href="https://1380833884-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa2Y94auFuxArnQG5CF2x%2Fuploads%2Fgit-blob-794ee2f6e7160affe67c2b1aca1caae1559c9537%2Fstart2.png?alt=media">start2.png</a></td></tr><tr><td><strong>Quick start</strong></td><td>See a full example of using TFHE-rs to compute on encrypted data</td><td><a href="/tfhe-rs/tfhe-rs/0.8/get-started/quick_start.md">Quick start</a></td><td><a href="https://1380833884-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa2Y94auFuxArnQG5CF2x%2Fuploads%2Fgit-blob-84e7b26136ae0010e6a313fb6432333cbc23d281%2Fstart3.png?alt=media">start3.png</a></td></tr></tbody></table>

## Build with TFHE-rs

Start building with TFHE-rs by exploring its core features, discovering essential guides, and learning more with user-friendly tutorials.

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Fundamentals</strong></td><td>Explore the core features.</td><td><ul><li><a href="/tfhe-rs/tfhe-rs/0.8/fundamentals/configure-and-generate-keys.md">Configure</a></li><li><a href="/tfhe-rs/tfhe-rs/0.8/fundamentals/encrypt-data.md">Encrypt data</a></li></ul></td><td><a href="https://1380833884-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa2Y94auFuxArnQG5CF2x%2Fuploads%2Fgit-blob-db74dbcb555ece9e55db2fb1f46865afda731ccf%2Fbuild1.png?alt=media">build1.png</a></td></tr><tr><td><strong>Guides</strong></td><td>Deploy your project.</td><td><ul><li><a href="/tfhe-rs/tfhe-rs/0.8/guides/run_on_gpu.md">Run on GPU</a></li><li><a href="/tfhe-rs/tfhe-rs/0.8/guides/rust_configuration.md">Configure Rust</a></li></ul></td><td><a href="https://1380833884-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa2Y94auFuxArnQG5CF2x%2Fuploads%2Fgit-blob-b73fb94c4da0baf0663f79c74e67fc243cb2ed18%2Fbuild2.png?alt=media">build2.png</a></td></tr><tr><td><strong>Tutorials</strong></td><td>Learn more with tutorials.</td><td><ul><li><a href="/tfhe-rs/tfhe-rs/0.8/tutorials/see-all-tutorials.md#start-here">Start here</a></li><li><a href="/tfhe-rs/tfhe-rs/0.8/tutorials/see-all-tutorials.md#go-further">Go further</a></li></ul></td><td><a href="https://1380833884-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa2Y94auFuxArnQG5CF2x%2Fuploads%2Fgit-blob-07fea976044a7544d615347d2511116027127eba%2Fbuild3.png?alt=media">build3.png</a></td></tr></tbody></table>

## Explore more

Access to additional resources and join the Zama community.

### References & Explanations

Take a deep dive into TFHE-rs, exploring APIs from the highest to the lowest level of abstraction and accessing additional resources for in-depth explanations.

* [Rust API reference](https://docs.rs/tfhe/latest/tfhe/): High-level API that abstracts cryptographic complexities and simplifies the development and more
* [Fine-grained APIs](/tfhe-rs/tfhe-rs/0.8/references/fine-grained-apis.md): Mid-level APIs that enable evaluation of Boolean, short integer, and integer circuits
* [Core crypto API](/tfhe-rs/tfhe-rs/0.8/references/core-crypto-api.md): Low-level API with the primitive functions and types of the TFHE scheme
* [TFHE deep dive](/tfhe-rs/tfhe-rs/0.8/explanations/tfhe-deep-dive.md): Resources that explain the Fully Homomorphic Encryption scheme - TFHE

### Support channels

Ask technical questions and discuss with the community. Our team of experts usually answers within 24 hours during working days.

* [Community forum](https://community.zama.ai/)
* [Discord channel](https://discord.com/invite/fhe-org)

### Developers

Collaborate with us to advance the FHE spaces and drive innovation together.

* [Contribute to TFHE-rs](/tfhe-rs/tfhe-rs/0.8/developers/contributing.md)
* [Check the latest release note](https://github.com/zama-ai/tfhe-rs/releases)
* [Request a feature](https://github.com/zama-ai/tfhe-rs/issues/new?assignees=\&labels=feature_request\&projects=\&template=feature_request.md\&title=)
* [Report a bug](https://github.com/zama-ai/tfhe-rs/issues/new?assignees=\&labels=triage_required\&projects=\&template=bug_report.md\&title=)

***

{% hint style="success" %}
**Zama 5-Question Developer Survey**

We want to hear from you! Take 1 minute to share your thoughts and helping us enhance our documentation and libraries. **👉** [**Click here**](https://www.zama.ai/developer-survey) to participate.
{% endhint %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.zama.org/tfhe-rs/tfhe-rs/0.8/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.