The .tidelift file allows you to easily configure your projects with essential metadata for integrating with the Tidelift platform. This file is recognized by the Tidelift CLI and the Tidelift VS Code Extension
.tidelift should be placed in the root of your project, and Tidelift recommends committing the file to your source control system.
Format
The .tidelift file uses a simple key-value format with each key and value separated by an equals sign.
Lines beginning with `#` are assumed to be comments, and are ignored.
Minimal example:
TIDELIFT_ORGANIZATION=my-organization
TIDELIFT_PROJECT=my-project
Configuration Reference
These commonly used values can be set via the .tidelift file:
- TIDELIFT_ORGANIZATION: Your organization's name within Tidelift. Not to be confused with your organization's "display name".
- TIDELIFT_PROJECT: The name of your Project within Tidelift.
- TIDELIFT_RECURSIVE_MANIFEST_SEARCH: Whether to process directories recursively when searching for manifest files. Default: `false`
- TIDELIFT_EXCLUDED_MANIFESTS: Used to exclude certain files/directories when searching for manifest files. This is a comma separated list of paths
- TIDELIFT_TIMEOUT: The maximum amount of time in seconds the CLI will wait for a reply. Default: `30` Maximum: `300`
Additional values are also supported:
- TIDELIFT_API_HOSTNAME: Defaults to`https://api.tidelift.com`
- TIDELIFT_GO_NO_RESOLVE: Skip resolution of go module dependencies.
- TIDELIFT_MAVEN_NO_RESOLVE: Skip resolution of maven dependencies using `mvn`.
- TIDELIFT_MAVEN_FORCE_DEP_PLUGIN: Set to `1` to ensure Maven Dependency Plugin is installed for lockfile resolution even when it's not available in environment.
- TIDELIFT_GRADLE_NO_RESOLVE: Skip resolution of gradle dependencies.
- TIDELIFT_GRADLE_CONFIGURATION_PATTERN: Limit the configurations resolved in a Gradle project. Java regex passed to gradle via `-PconfigurationPattern`
- TIDELIFT_PYTHON_BINARY: Path to python executable, overrides discovery using `$PATH`
- TIDELIFT_PYTHON_NO_RESOLVE: Set to `1` to skip requirements.txt dependency resolution. Does not affect other python manifest types.
- TIDELIFT_PYTHON_RESOLVE_LOCAL: Set to `1` to skip creation of virtual environment for requirements.txt resolution and use `pip freeze`.
- TIDELIFT_TMPDIR: Location of temporary scratch directory. Omit to use system default.
- TIDELIFT_NPM_NO_RESOLVE: Skip resolution of NPM dependencies when no lockfile is present.
- TIDELIFT_NUGET_NO_RESOLVE: Skip resolution of Nuget dependencies.
Downloading
In addition to manually creating .tidelift, you can download a preconfigured .tidelift file from the web application.
- From the Tidelift web application, navigate to the project, select "Edit project settings", then under "Use with Tidelift CLI" select "Download File".
- Save this file in your project's root directory, and name it .tidelift.
- Note that as these files have no API credentials, they can be checked into your source control system.
Creating from the CLI
The tidelift CLI can create the .tidelift file for you when creating a new project via tidelift projects new
CLI Troubleshooting
Environment variables and command line flags will take precedence over a .tidelift file. Use tidelift selftest to find exactly where each setting is coming from.