> For the complete documentation index, see [llms.txt](https://docs.telys.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.telys.ai/operations/supported-platforms.md).

# Supported platforms

Telys has two layers with different portability. The public SDK (`telys`) is **pure Python** — a `py3-none-any` wheel that installs anywhere a supported Python runs. The **signed native runtime** that executes collection operations is a platform-specific binary, shipped for a fixed set of targets. This page covers that runtime.

## Runtime platform matrix

| `platform_tag()` | OS / architecture    | Runtime  | `lib_ext` | Status            |
| ---------------- | -------------------- | -------- | --------- | ----------------- |
| `macos-arm64`    | macOS, Apple Silicon | Yes      | `dylib`   | Supported         |
| `linux-x86_64`   | Linux, x86-64        | Yes      | `so`      | Supported         |
| `linux-arm64`    | Linux, ARM64         | Yes      | `so`      | Experimental      |
| `macos-x86_64`   | macOS, Intel         | No       | `dylib`   | Not yet supported |
| Windows          | Windows, x86-64      | Via WSL2 | `dll`     | Use WSL2          |

`platform_tag()` returns `<os>-<arch>`; the library extension follows the OS (`dylib`, `so`, `dll`). The runtime installs under `runtime/<platform_tag>/` — see [On-disk layout](/operations/on-disk-layout.md).

## Platform notes

{% tabs %}
{% tab title="macOS" icon="apple" %}
**Apple Silicon (`macos-arm64`) is fully supported.** Install and sign in:

```bash
pipx install telys
telys login
telys runtime verify
```

**Intel Macs (`macos-x86_64`) are not yet supported.** The SDK installs and imports, and the offline `telys.verify` APIs work, but collection operations report that no runtime is installed for this platform.
{% endtab %}

{% tab title="Linux" icon="linux" %}
**`linux-x86_64` is fully supported.** **`linux-arm64` is experimental** — it installs and runs, but validate it for your workload before relying on it in production.

```bash
pipx install telys
telys login
telys runtime status
```

{% endtab %}

{% tab title="Windows" icon="windows" %}
There is no native Windows runtime. Run Telys inside **WSL2**, which presents as `linux-x86_64` — a fully supported target. Install and use it exactly as on Linux.

```bash
# inside your WSL2 shell
pipx install telys
telys login
```

{% endtab %}
{% endtabs %}

## SDK vs runtime

This distinction matters when planning a deployment:

* **The SDK is portable.** `pip install telys` / `pipx install telys` succeeds on any OS and architecture with a supported Python, because the wheel is pure Python. You can `import telys`, build embedding profiles, and call the `telys.verify` functions without a runtime.
* **Collection operations need the runtime.** Creating, ingesting into, or searching a collection loads the signed native runtime via ctypes, and that binary exists only for the supported platforms above. The `Algenta*` embedders additionally need the native kernel.

{% hint style="info" %}
On an unsupported platform, `telys runtime status` returns non-zero and any collection call raises `RuntimeNotInstalled`. To verify a release manifest or a license offline, the SDK alone is enough. See [The signed runtime & trust model](/understand-telys/signed-runtime-trust.md).
{% endhint %}

## See also

* [Python version support](/operations/python-version-support.md) — the Python versions Telys runs on.
* [On-disk layout](/operations/on-disk-layout.md) — where the per-platform runtime is installed.
* [Platform-specific issues](/troubleshooting/platform-specific.md) — fixes for common per-OS problems.

## Next steps

* [Install Telys](/start-here/install.md) — set up the SDK and runtime on a supported platform.
* Next: [Verify your install](/start-here/verify-install.md) to confirm the runtime is ready.


---

# 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.telys.ai/operations/supported-platforms.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.
