mirror of
https://github.com/astral-sh/ruff.git
synced 2025-08-06 11:48:08 +00:00
3ee3434187
## Summary
This PR mirrors the environment variable implementation we have in uv:
efc361223c/crates/uv-static/src/env_vars.rs (L6-L7).
See: https://github.com/astral-sh/ty/issues/773.
55 lines
1.6 KiB
Markdown
55 lines
1.6 KiB
Markdown
# 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 isn't 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:
|
|
|
|
### `CONDA_PREFIX`
|
|
|
|
Used to detect an activated Conda environment location.
|
|
If both `VIRTUAL_ENV` and `CONDA_PREFIX` are present, `VIRTUAL_ENV` will be preferred.
|
|
|
|
### `RAYON_NUM_THREADS`
|
|
|
|
Specifies an upper limit for the number of threads ty uses when performing work in parallel.
|
|
Equivalent to `TY_MAX_PARALLELISM`.
|
|
|
|
This is a standard Rayon environment variable.
|
|
|
|
### `VIRTUAL_ENV`
|
|
|
|
Used to detect an activated virtual environment.
|
|
|
|
### `XDG_CONFIG_HOME`
|
|
|
|
Path to user-level configuration directory on Unix systems.
|
|
|