ty
An extremely fast Python type checker and language server, written in Rust.
File Explorer
- 1_bug_report.yaml
- 2_question.yaml
- config.yml
- build-binaries.yml
- build-docker.yml
- ci.yaml
- daily_property_tests.yml
- notify-dependents.yml
- publish-docs.yml
- publish-mirror.yml
- publish-pypi.yml
- publish-versions.yml
- release.yml
- actionlint.yaml
- PULL_REQUEST_TEMPLATE.md
- renovate.json5
- zizmor.yml
- v0.json
- fathom.html
- main.html
- favicon.ico
- logo-letter.svg
- ty-benchmark-cli-light.svg
- ty-benchmark-cli.svg
- code-completion.png
- diagnostics1.dark.png
- diagnostics1.light.png
- diagnostics2.dark.png
- diagnostics2.light.png
- diagnostics3.dark.png
- diagnostics3.light.png
- diagnostics4.dark.png
- diagnostics4.light.png
- find-references.png
- inlay-hints.png
- inline-diagnostics.png
- quick-fix.png
- diagnostics.md
- language-server.md
- type-system.md
- extra.js
- cli.md
- configuration.md
- editor-settings.md
- environment.md
- exit-codes.md
- rules.md
- typing-faq.md
- extra.css
- coming-from-mypy-or-pyright.md
- configuration.md
- editors.md
- exclusions.md
- index.md
- installation.md
- modules.md
- python-version.md
- rules.md
- suppression.md
- type-checking.md
- __init__.py
- __main__.py
- _find_ty.py
- py.typed
- autogenerate_files.sh
- build_ty_pgo.py
- build_ty_pgo.py.lock
- release.sh
- transform_readme.py
- update_schemastore.py
- .editorconfig
- .gitattributes
- .gitignore
- .gitmodules
- .markdownlint.yaml
- .pre-commit-config.yaml
- .python-version
- _typos.toml
- AGENTS.md
- BENCHMARKS.md
- CHANGELOG.md
- CONTRIBUTING.md
- dist-workspace.toml
- Dockerfile
- LICENSE
- mkdocs.yml
- pyproject.toml
- README.md
- ruff
- SECURITY.md
- uv.lock
# Installation Guide
pythonPrerequisites
Setup Steps
uvx ty check
Run ty quickly using uvx to perform type checking.
Key Commands
uvx ty check
Run the ty type checker to check the project.
ty officially supports type checking code targeting Python 3.10 and later.
# Use via CDN
jsDelivrjsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.
Link
Example
Command Glossary
Commands referenced in this DOCs, explained below.
ruff
View Details ▼
ruff
An extremely fast Python linter and code formatter, written in Rust.
See also: `black`.
tldr ruff check
View documentation for the Ruff linter:
tldr ruff format
View documentation for the Ruff code formatter:
uvx
View Details ▼
uvx
This command is an alias of `uv tool run`.
tldr uv tool
View documentation for the original command:
# Project Badges
// repository documentation
Was this content helpful?
(0 ratings)
