Skip to content

Getting started

This page installs TyPy from a release archive, then checks, builds and runs a first program.

What you need

TyPy runs on x86_64 Linux with glibc 2.39 or later, such as Ubuntu 24.04 or Debian 13. It links programs with the system C toolchain, so cc must be installed:

sudo apt install build-essential

Install from a release archive

Download typy-0.5.0-x86_64-unknown-linux-gnu.tar.gz and its .sha256 file from the release page, check the archive and unpack it:

sha256sum --check typy-0.5.0-x86_64-unknown-linux-gnu.tar.gz.sha256
tar -xzf typy-0.5.0-x86_64-unknown-linux-gnu.tar.gz
export PATH="$PWD/typy-0.5.0-x86_64-unknown-linux-gnu/bin:$PATH"
typy --version

The archive holds the typy command in bin/ and the runtime library for glibc and musl targets in lib/typy/. Keep the two together: typy finds the runtime beside itself.

A first program

Save this program as words.py. Annotations are required on function parameters and returns; a variable takes the type of its first value.

def longest(words: list[str]) -> str:
    best = ""
    for word in words:
        if len(word) > len(best):
            best = word
    return best


counts: dict[str, int] = {}
text = "the quick brown fox jumps over the lazy dog the end"
for word in text.split():
    counts[word] = counts.get(word, 0) + 1
print(longest(text.split()), counts["the"], f"{len(counts)} distinct words")

Check, build and run

typy check reports every problem without generating code:

typy check words.py

typy run builds the program and runs it. Arguments after -- go to the program:

typy run words.py

typy build writes a native executable beside the source, here words, that runs without TyPy or Python installed:

typy build words.py
./words

typy build --release optimises for speed, and --release-small for size; -o PATH names the executable. typy build --emit=STAGE writes one stage of the compiler instead, such as typed-ast or llvm-ir.

When a program is refused

TyPy refuses a program it cannot compile with CPython's meaning. Saved as mixed.py, this list would need to hold both an int and a str, which a list[T] cannot:

mixed = [1, "two"]
print(mixed)

The diagnostic gives a code, the place, one sentence that says what is wrong and the rule it falls outside:

error[E0409]: the items of a list have one type; this is a str, and the list holds int
 --> mixed.py:1:13

Troubleshooting explains each code, and the language reference lists what each release accepts.