README
¶
NOT READY FOR PRODUCTION
This is an ongoing work on tctl UX based on proposals:
- https://github.com/temporalio/proposals/tree/master/cli
- https://github.com/temporalio/proposals/pulls (marked with tctl)
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.
Switching to updated tctl v1.14.0-alpha
The package contains both tctl v1.12.1 and the updated tctl v1.14.0-alpha. Version v1.14.0-alpha brings updated UX, commands and flags semantics, new features (see details). Please expect more of upcoming changes in v1.14.0
By default, executing tctl commands will execute commands from v1.12.1. In order to switch to experimental v1.14.0-alpha run
tctl config set version next
This will create a configuration file (~/.config/temporalio/tctl.yaml) and set tctl to v1.14.0-alpha.
To switch back to the stable v1.12.1, run
tctl config set version old
License
MIT License, please see LICENSE for details.
Directories