Skip to content
Thyme Docs

Installation

The documented releases are CLI 0.10.0 and SDK 0.8.0. The CLI installs as the thyme command.

npm install -g @thyme-labs/cli@latest
thyme --version
thyme --help

For a project without a global installation, use npx @thyme-labs/cli@latest in place of thyme.

Create a project

thyme init my-flow-project
cd my-flow-project
npm install
thyme new heartbeat

The generated package includes the SDK, viem, Zod, TypeScript, and the CLI. Commit its lockfile so collaborators and CI use the same dependency versions.

Install Deno for local execution

thyme run imports and executes task source in a Deno subprocess. Install Deno using the instructions at deno.com, then check it is on your path:

deno --version

Deno is not required for creating a project or using management commands. Hosted execution supplies its own runtime.

Configure local inputs

cp .env.example .env

Set SIMULATE_ACCOUNT to a valid Ethereum address, representing the account your task will execute as. Set RPC_URL when your task reads the chain or you use --simulate. Neither setting grants the CLI signing authority.

Project and task .env files are local configuration. Authentication is stored separately in ~/.thyme/config.json; thyme login does not populate .env.

Continue with authentication and the quickstart.