ty/docs/reference/env.md
Charlie Marsh e69569b4fe
Some checks failed
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
Update list of referenced environment variables (#612)
Closes #564.
2025-06-08 20:10:20 -04:00

42 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Environment variables
ty defines and respects the following environment variables:
## `TY_LOG`
If set, ty will use this value as the log level for its `--verbose` output. Accepts any filter compatible with the `tracing_subscriber` crate. For example:
- `TY_LOG=uv=debug` is the equivalent of `-vv` to the command line
- `TY_LOG=trace` will enable all trace-level logging.
See the [tracing documentation](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#example-syntax) for more.
## `TY_LOG_PROFILE`
If set to `"1"` or `"true"`, ty will enable flamegraph profiling. This creates a `tracing.folded` file that can be used to generate flame graphs for performance analysis.
## `TY_MAX_PARALLELISM`
Specifies an upper limit for the number of tasks ty is allowed to run in parallel. For example, how many files should be checked in parallel.
This isnt the same as a thread limit. ty may spawn additional threads when necessary, e.g. to watch for file system changes or a dedicated UI thread.
## Externally defined variables
ty also reads the following externally defined environment variables:
### `RAYON_NUM_THREADS`
Specifies an upper limit for the number of threads ty uses when performing work in parallel. Equivalent to `TY_MAX_PARALLELISM`.
### `VIRTUAL_ENV`
Used to detect an activated virtual environment.
### `CONDA_PREFIX`
Used to detect an activated Conda environment location. If both `VIRTUAL_ENV` and `CONDA_PREFIX` are present, `VIRTUAL_ENV` will be preferred.
### `XDG_CONFIG_HOME`
Path to user-level configuration directory on Unix systems.