diff --git a/crates/ty/docs/cli.md b/crates/ty/docs/cli.md index 13465bfb0f..7bf076ee27 100644 --- a/crates/ty/docs/cli.md +++ b/crates/ty/docs/cli.md @@ -67,7 +67,7 @@ over all configuration files.
--project projectRun the command within the given project directory.
All pyproject.toml files will be discovered by walking up the directory tree from the given project directory, as will the project's virtual environment (.venv) unless the venv-path option is set.
Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.
---python pathPath to the Python environment.
+--python, --venv pathPath to the Python environment.
ty uses the Python environment to resolve type information and third-party dependencies.
If not specified, ty will attempt to infer it from the VIRTUAL_ENV or CONDA_PREFIX environment variables, or discover a .venv directory in the project root or working directory.
If a path to a Python interpreter is provided, e.g., .venv/bin/python3, ty will attempt to find an environment two directories up from the interpreter's path, e.g., .venv. At this time, ty does not invoke the interpreter to determine the location of the environment. This means that ty will not resolve dynamic executables such as a shim.