Installation

Requirements

• Python 3.12+
• uv (recommended) or pip
• A Thyme instance URL and API key from your administrator

Thyme is offered as a hosted service. Your administrator (or platform team) provisions the instance and gives you the base URL plus an API key - you don't stand it up yourself.

Install the SDK

uv add thyme-sdk

pip install thyme-sdk

Verify

thyme version
# thyme 0.1.0

Connect to your instance

Run thyme login once with the URL and API key you were given:

thyme login --url https://thyme.your-company.com --api-key tk_your_key

This stores credentials at ~/.thyme/credentials (file mode 0600). Subsequent thyme commit, thyme query, and other CLI commands authenticate automatically.

If you'd rather not store credentials on disk (CI environments, ephemeral shells), set the environment variables instead:

export THYME_API_URL=https://thyme.your-company.com
export THYME_API_KEY=tk_your_key
export THYME_FRONTEND_URL=https://thyme.your-company.com   # optional, enables clickable Results: links

See Authentication for the full credential priority chain.