Show Menu
Cheatography
  1. Home >
  2. Software >

tctl to Temporal CLI Quick Guide Cheat Sheet (DRAFT) by

Make the move from tctl and keep working with Temporal CLI

This is a draft cheat sheet. It is a work in progress and is not finished yet.

New Features

Built-in Temporal Develo­pment Server
Built-in Server Web UI and metrics endpoint
Workflow Schedules
Worker versioning and Build IDs
Batch actions on selected Workflow Executions
API-key support
Proxy support

New Elements

 
temporal batch [command] [subco­mmands] --query
 
temporal schedule [subco­mmands]

backfill, create, delete, describe, list, toggle, trigger, update
 
temporal workflow [subco­mmands] --tls, --tls-­key­-data, --tls-­cer­t-data, --tls-­ca-data
 
temporal workflow [subco­mmands] --api-key
 
temporal task-queue get-bu­ild­-ids, get-bu­ild­-id­s-r­eac­hab­ility, update­-bu­ild-ids
Enviro­nmental variables: 
TEMPORAL_CODEC_AUTH, TEMPOR­AL_­COD­EC_­END­POINT

Changes

 
temporal operator cluster [subco­mmands] [options]

tctl cluster
 
temporal operator namespace [subco­mmands] [options]

tctl namespace
 
temporal operator search­-at­tri­butes [subco­mmands] [options]

tctl workfl­ow|­admin [subco­mmands] --sear­ch_­att­r_key \<k­ey>
 
temporal workflow [subco­mmands] [options]

tctl admin workflow [subco­mmands] [options]
 
temporal workflow show

tctl workflow showid
 
task-queue

taskqueue, t

Gone

 
tctl admin db, decode, dlq, histor­y_host, shard, refres­h_tasks
 
tctl workflow descri­beid, listall, listar­chived, observe , observe id, reset-­batch
 
TEMPORAL_CLI_PLUGIN_DATA_CONVERTER
 
TEMPORAL_CLI_PLUGIN_HEADERS_PROVIDER