Skip to content
Thyme Docs

CLI Overview

@thyme-labs/cli 0.10.0 provides the thyme command. It creates task projects, runs tasks locally, uploads immutable releases, manages cloud resources, and verifies supported Roles profiles.

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

Local runs require Deno on PATH and installed project dependencies. See installation.

Command index

CommandPurpose
init [name]Scaffold a project.
new [task]Create an initially inert task.
listDiscover local tasks.
run [task]Evaluate locally, preview calls, simulate callbacks, optionally persist storage.
login / logoutManage standard or workspace-bound credentials.
upload [task]Bundle and publish an immutable function release.
api-urlInspect API endpoint resolution.
projects, chains, functionsManage projects and releases; discover chains.
executables, executionsConfigure, schedule, run, simulate, and inspect cloud automation.
profiles, secrets, webhooks, usageManage associated resources and inspect usage.
api <method> <path>Call a versioned management route with a JSON body.
verify roles-profileIndependently inspect supported signature requests or deployed profiles.

Use thyme <command> --help or thyme <resource> <command> --help for the installed command's options. Cloud management does not require a local task project.

Global flags

FlagPurpose
-V, --versionShow installed CLI version.
-h, --helpShow help; available on individual commands.
--ciDisable prompts, accept confirmations, and fail when other required values are missing.
-y, --yesAccept confirmation prompts while keeping other interactive prompts.

--ci and --yes work before the command and directly on commands that prompt. A non-TTY stdin/stdout or recognized CI environment variable also disables prompts. See CI use.

The project gate

new, list, run, and upload require a functions/ directory and @thyme-labs/sdk or @thyme-labs/cli declared in package.json. Run them from the project root. thyme init creates this structure; it does not install dependencies.

Typical workflow

thyme init my-flow-project
cd my-flow-project
npm install
thyme new monitor
cp .env.example .env
# Set SIMULATE_ACCOUNT; set RPC_URL if the task reads the chain.
thyme run monitor
thyme login
thyme upload monitor --workspace WORKSPACE_ID --project PROJECT_ID --tag v1

Upload creates code; an executable adds runtime configuration. Create and operate it with the Console or management commands. See configuration for credentials, endpoint selection, and per-task files.