README
¶
The Temporal CLI is a command-line tool you can use to perform various tasks on a Temporal Server. It can perform namespace operations such as register, update, and describe as well as Workflow operations like start Workflow, show Workflow history, and signal Workflow.
Documentation for the Temporal command line interface is located at our main site.
Quick Start
Run make from the project root. You should see an executable file called tctl. Try a few example commands to
get started:
./tctl for help on top level commands and global options
./tctl namespace for help on namespace operations
./tctl workflow for help on workflow operations
./tctl task-queue for help on tasklist operations
(./tctl help, ./tctl help [namespace|workflow] will also print help messages)
Note: Make sure you have a Temporal server running before using the CLI.
Trying out new tctl v2.0.0-beta with updated UX
Note Switching to tctl v2.0.0-beta is not recommended on production environments.
The package contains both tctl v1.16 and the updated tctl v2.0.0-beta. Version v2.0.0-beta brings updated UX, commands and flags semantics, new features (see details). Please expect more of upcoming changes in v2.0.0
By default, executing tctl commands will execute commands from v1.16. In order to switch to experimental v2.0.0-beta run
tctl config set version 2
This will create a configuration file (~/.config/temporalio/tctl.yaml) and set tctl to v2.0.0-beta.
To switch back to the stable v1.16, run
tctl config set --version current
License
MIT License, please see LICENSE for details.
Directories