Environment Variables

TSTyche reads the following environment variables on startup.

Variables

How the variable value is parsed depends on its type:

boolean is interpreted as true if the value is not an empty string; otherwise false
number is parsed using the Number.parseFloat() method
string is simply a string

The values are used as provided without validation.

Use the --showConfig command line option to inspect the resolved configuration.

`TSTYCHE_NO_COLOR`

Default: false; or true, if the NO_COLOR environment variable is set and its value is not an empty string.
Type: boolean

Disables color in the output.

`TSTYCHE_NO_INTERACTIVE`

Default: !process.stdout.isTTY
Type: boolean

Disables interactive elements in the output.

`TSTYCHE_NPM_REGISTRY`

Default: https://registry.npmjs.org
Type: string

The base URL of the npm registry to use.

`TSTYCHE_STORE_PATH`

Default: $HOME/Library/TSTyche on macOS; or %LocalAppData%/TSTyche on Windows, if the LocalAppData environment variable is set; or $XDG_DATA_HOME/TSTyche on Linux, if the XDG_DATA_HOME environment variable is set; otherwise $HOME/.local/share/TSTyche.
Type: string

The directory where the fetched versions of the typescript package are stored. A relative path is resolved relative to the current directory.

`TSTYCHE_TIMEOUT`

Default: 30
Type: number

The number of seconds before stale operations time out. The value of 0 disables the timeout.

This timeout applies to requests that fetch metadata and tarballs of typescript packages.

`TSTYCHE_TYPESCRIPT_MODULE`

Default: typescript
Type: string

The module name or path to be used as the currently installed TypeScript module. The value is resolved using the import.meta.resolve() function.

By default, TSTyche runs type tests using TypeScript currently installed in the project. When the path does not resolve, the latest version is used instead. To learn more, see the target option.