Environment Variables

TSTyche must know few details about the environment before starting. These can be set using the environment variables.

Options

The parsing logic of the option value 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() (opens in a new tab) method,
string is simply a string.

Values of the environment variables are not validated, meaning that they are passed around as provided without any additional checks.

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

`TSTYCHE_NO_COLOR`

Default: false; or true, if the NO_COLOR (opens in a new tab) environment variable is set and its value is not an empty string.
Type: boolean

Specifies whether color should be disabled in the output.

`TSTYCHE_NO_INTERACTIVE`

Default: !process.stdout.isTTY
Type: boolean

Specifies whether interactive elements should be disabled in the output.

`TSTYCHE_NPM_REGISTRY`

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

The base URL of the npm registry (opens in a new tab) 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 installed versions of the typescript package are stored. Relative path is resolved relative to the current directory.

`TSTYCHE_TIMEOUT`

Default: 30
Type: number

The number of seconds to wait before giving up stale operations. The value of 0 disables the timeout.

The timeout value is passed to requests to fetch the 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() (opens in a new tab) function.

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

Command Line System Requirements