diff --git a/crates/ty/docs/cli.md b/crates/ty/docs/cli.md index 4df73846cbdb1..ac26903b0005f 100644 --- a/crates/ty/docs/cli.md +++ b/crates/ty/docs/cli.md @@ -63,7 +63,10 @@ ty check [OPTIONS] [PATH]...

ty will search in the resolved environments's site-packages directories for type information and third-party imports.

--python-platform, --platform platform

Target platform to assume when resolving types.

This is used to specialize the type of sys.platform and will affect the visibility of platform-specific functions and attributes. If the value is set to all, no assumptions are made about the target platform. If unspecified, the current system's platform will be used.

-
--python-version, --target-version version

Python version to assume when resolving types

+
--python-version, --target-version version

Python version to assume when resolving types.

+

The Python version affects allowed syntax, type definitions of the standard library, and type definitions of first- and third-party modules that are conditional on the Python version.

+

By default, the Python version is inferred as the lower bound of the project's requires-python field from the pyproject.toml, if available. Otherwise, the latest stable version supported by ty is used, which is currently 3.13.

+

ty will not infer the Python version from the Python environment at this time.

Possible values: