Temporal CLI task-queue command reference

Task Queue commands allow operations to be performed on Task Queues. To run a Task Queue command, run temporal task-queue [command] [command options]

describe

The temporal task-queue describe command provides poller information for a given Task Queue.

The Server records the last time of each poll request. A LastAccessTime value in excess of one minute can indicate the Worker is at capacity (all Workflow and Activity slots are full) or that the Worker has shut down. Workers are removed if 5 minutes have passed since the last poll request.

Information about the Task Queue can be returned to troubleshoot server issues.

temporal task-queue describe --task-queue=MyTaskQueue --task-queue-type="activity"

Use the following options to change the behavior of this command.

• --fields

• --address

• --codec-auth

• --codec-endpoint

• --color

• --context-timeout

• --env

• --fields

• --grpc-meta

• --namespace

• --output

• --task-queue

• --task-queue-type

• --time-format

• --tls

• --tls-ca-path

• --tls-cert-path

• --tls-disable-host-verification

• --tls-key-path

• --tls-server-name

list-partition

The temporal task-queue list-partition command displays the partitions of a Task Queue, along with the matching node they are assigned to.

Use the following options to change the command's behavior.

• --address

• --codec-auth

• --codec-endpoint

• --color

• --context-timeout

• --env

• --grpc-meta

• --namespace

• --output

• --task-queue

• --tls

• --tls-ca-path

• --tls-cert-path

• --tls-disable-host-verification

• --tls-key-path

• --tls-server-name

get-build-ids

Fetch the sets of compatible build IDs associated with a Task Queue and associated information.

• --address

• --codec-auth

• --codec-endpoint

• --color

• --context-timeout

• --env

• --grpc-meta

• --max-sets

• --namespace

• --task-queue

• --tls

• --tls-ca-path

• --tls-cert-path

• --tls-disable-host-verification

• --tls-key-path

• --tls-server-name

get-build-id-reachability

Determines whether Build IDs can be used for new, existing, or closed Workflows. Both the --build-id and --task-queue options can be specified multiple times. If a Task Queue isn't provided, reachability for the provided Build IDs is checked against all Task Queues.

• --address

• --build-id

• --codec-auth

• --codec-endpoint

• --color

• --context-timeout

• --env

• --grpc-meta

• --namespace

• --reachability-type

• --task-queue

• --tls

• --tls-ca-path

• --tls-cert-path

• --tls-disable-host-verification

• --tls-key-path

• --tls-server-name

update-build-ids

Provides various commands for adding or changing the sets of compatible build IDs associated with a Task Queue. See the help text provided for each sub-command for more.