Environment variables for tctl
What are the environment variables for tctl?
92 docs tagged with "tctl"
View All TagsHow to install tctl
You can install tctl in four ways, described in this topic.
tctl activity
How to operate Activity Executions using tctl.
tctl activity complete
How to provide a result and complete an Activity Execution using tctl.
tctl activity fail
How to fail an Activity Execution using tctl.
tctl admin
How to run admin-level tctl commands.
tctl admin cluster
Running admin-level operations on clusters.
tctl admin cluster add_search_attributes
Adding custom Search Attributes to a Cluster.
tctl admin cluster describe
Displaying Cluster information.
tctl admin cluster get_search_attributes
Showing existing search attributes.
tctl admin cluster list
Listing Cluster information.
tctl admin cluster remove_remote_cluster
Removing remote Clusters.
tctl admin cluster remove_search_attributes
Removing custom search metadat from a Cluster.
tctl admin cluster upsert_remote_cluster
How to run admin-level tctl commands.
tctl admin db clean
How to clean up corrupted Workflows using tctl.
tctl admin db scan
Scanning for corrupted executions in a database
tctl admin decode
Decoding payloads.
tctl admin decode base64
Decoding Payloads to Base64.
tctl admin decode proto
Decoding proto payloads.
tctl admin dlq
Running admin operations on DLQ.
tctl admin dlq merge
Merging DLQ messages.
tctl admin dlq purge
Deleting DLQ messages.
tctl admin dlq read
Reading DLQ messages.
tctl admin history_host
Overview of history_host commands
tctl admin history_host describe
Describing the information in a history host
tctl admin history_host get_shardid
Providing the shardId on command
tctl admin membership
Run admin operations on membership
tctl admin membership list_db
How to describe Cluster membership items
tctl admin membership list_gossip
How to describe ringpop membership items
tctl admin shard
Admin-level operations on a specific shard
tctl admin shard close_shard
closing a shard with a given shard Id
tctl admin shard describe
Describes Id of shard.
tctl admin shard describe_task
displaying information on a Task within a shard
tctl admin shard list_tasks
listing tasks for a given shard Id and Task type
tctl admin shard remove_task
removing a Task with given information
tctl admin workflow
Operating admin-level Workflow Executions.
tctl admin workflow delete
Deleting the Workflow Execution.
tctl admin workflow describe
Description of Workflow Execution.
tctl admin workflow refresh_tasks
Refreshing Workflow Tasks.
tctl admin workflow show
Showing Workflow history.
tctl batch
A tctl batch command enables you to affect multiple existing Workflow Executions with a single command.
tctl batch describe
How to describe the progress of a batch job using tctl.
tctl batch list
How to list batch jobs using tctl.
tctl batch start
How to start a batch job using tctl.
tctl batch terminate
How to terminate a batch job using tctl.
tctl cluster
How to operate Temporal Clusters using tctl.
tctl cluster get-search-attributes
How to list all Search Attributes using tctl.
tctl cluster health
How to check the health of the Frontend Service using tctl.
tctl data-converter
How to operate custom Data Converters using tctl.
tctl dataconverter
How to operate custom Data Converters using tctl.
tctl dataconverter web
How to specify the WebSocket URL of a custom Data Converter using tctl.
tctl namespace
How to operate Namespaces using tctl.
tctl namespace describe
How to describe a Namespace using tctl.
tctl namespace list
How to list all Namespaces using tctl.
tctl namespace register
How to register a Namespace using tctl.
tctl namespace update
How to update a Namespace using tctl.
tctl schedule
How to operate Schedules using tctl.
tctl schedule backfill
How to backfill a Schedule using tctl.
tctl schedule create
How to create a Schedule using tctl.
tctl schedule delete
How to delete a Schedule using tctl
tctl schedule describe
How to describe a Schedule using tctl
tctl schedule list
How to list Schedules using tctl
tctl schedule toggle
How to toggle (pause/unpause) a Schedule using tctl.
tctl schedule trigger
How to trigger a Schedule Action using tctl
tctl schedule update
How to update a Schedule using tctl.
tctl task-queue
How to operate Task Queues using tctl.
tctl task-queue list-partition
How to list Task Queue partitions and the hostname for partitions using tctl.
tctl taskqueue
How to operate Task Queues using tctl.
tctl taskqueue describe
How to describe the poller information of a Task Queue using tctl.
tctl taskqueue list-partition
How to list Task Queue partitions and the hostname for partitions using tctl.
tctl workflow
How to operate Workflow Executions using tctl.
tctl workflow cancel
How to cancel a Workflow Execution using tctl.
tctl workflow count
How to count Workflow Executions using tctl.
tctl workflow describe
How to show information about a Workflow Execution using tctl.
tctl workflow describeid
How to show information about a Workflow Execution for a specified Workflow Id and optional Run Id using tctl.
tctl workflow list
How to list open or closed Workflow Executions using tctl.
tctl workflow listall
How to list all open or closed Workflow Executions using tctl.
tctl workflow listarchived
How to list archived Workflow Executions using tctl.
tctl workflow observe
How to show the progress of the Event History of a Workflow Execution using tctl.
tctl workflow observeid
How to show the progress of the Event History of a Workflow Execution for a specified Workflow Id and optional Run Id using tctl.
tctl workflow query
How to send a Query to a Workflow Execution using tctl.
tctl workflow reset
How to reset a Workflow Execution using tctl.
tctl workflow reset-batch
How to reset a batch of Workflow Executions using tctl.
tctl workflow run
How to start a new Workflow Execution and get Workflow progress using tctl.
tctl workflow scan
How to quickly list Workflow Executions without sorting using tctl.
tctl workflow show
How to show Workflow History using tctl.
tctl workflow showid
How to show Workflow History for a specified Workflow Id and optional Run Id using tctl.
tctl workflow signal
How to Signal a Workflow Execution using tctl.
tctl workflow stack
How to query Workflow Executions with __stack_trace using tctl.
tctl workflow start
How to start a new Workflow Execution using tctl.
tctl workflow terminate
How to terminate a Workflow Execution using tctl.
What is tctl?
tctl is a command-line tool that you can use to interact with a Temporal Cluster.