ty/docs/index.md
Zanie Blue 7f5f2fe158
Add a "type checking" page (#1915)
I was a bit unhappy that the "Introduction" had to explain concepts like
file selection and environment discovery. I also think the "Concepts"
sections didn't really make sense as "Installation" -> "Configuration",
I wanted a page for _using_ the type checker in between. This adds a new
page for "Type checking" and moves some of the content out of the
"Introduction". The "Features / Type checking" page is renamed to
"Features / Type system" to disambiguate — which I think is more
appropriate for the target readers anyway.

I think in the long run, we'll want to add "Guides" and have a "Type
checking your project", "Type checking a script", etc., but I think
that's out of scope for the beta.
2025-12-16 09:24:36 +01:00

846 B

ty

An extremely fast Python type checker and language server, written in Rust.

Getting started

Run ty with uvx to get started quickly:

uvx ty check

ty will check all Python files in the working directory or project by default.

See the type checking documentation for more details.

Installation

To install ty, see the installation documentation.

To add the ty language server to your editor, see the editors documentation.

Playground

ty has an online playground you can use to try it out on snippets or small projects.

!!! tip

The playground is a great way to share snippets with other people, e.g., when sharing a bug
report.