Temporal CLI task-queue command reference
Task Queue commands allow operations to be performed on Task QueuesWhat is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
Learn more.
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 QueueWhat is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
Learn more.
The ServerWhat is the Temporal Server?
The Temporal Server is a grouping of four horizontally scalable services.
Learn more 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.
In day-to-day conversations, the term Worker is used to denote both a Worker Program and a Worker Process. Temporal documentation aims to be explicit and differentiate between them.
Learn more 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
temporal fields
Customize fields to print.
Learn more - --address
temporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-auth
temporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpoint
temporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --color
temporal color
Color options for the CLI.
Learn more - --context-timeout
temporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --env
temporal env
Name of the environment to read environmental variables from.
Learn more - --fields
temporal fields
Customize fields to print.
Learn more - --grpc-meta
temporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --namespace
temporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --output
temporal output
Output format.
Learn more - --task-queue
temporal task-queue
Task Queue
Learn more - --task-queue-type
temporal task-queue-type
Task Queue type [workflow|activity].
Learn more - --time-format
temporal time-format
Format time as either relative, iso, raw.
Learn more - --tls
temporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-path
temporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-path
temporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verification
temporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-path
temporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-name
temporal tls-server-name
Overrides the target TLS server name.
Learn more
list-partition
The temporal task-queue list-partition
command displays the partitions of a Task QueueWhat is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
Learn more, along with the matching node they are assigned to.
Use the following options to change the command's behavior.
- --address
temporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-auth
temporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpoint
temporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --color
temporal color
Color options for the CLI.
Learn more - --context-timeout
temporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --env
temporal env
Name of the environment to read environmental variables from.
Learn more - --grpc-meta
temporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --namespace
temporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --output
temporal output
Output format.
Learn more - --task-queue
temporal task-queue
Task Queue
Learn more - --tls
temporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-path
temporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-path
temporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verification
temporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-path
temporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-name
temporal tls-server-name
Overrides the target TLS server name.
Learn more
get-build-ids
Fetch the sets of compatible build IDs associated with a Task Queue and associated information.
- --address
temporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-auth
temporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpoint
temporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --color
temporal color
Color options for the CLI.
Learn more - --context-timeout
temporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --env
temporal env
Name of the environment to read environmental variables from.
Learn more - --grpc-meta
temporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --max-sets
temporal max-sets
Limits how many compatible sets will be returned
Learn more - --namespace
temporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --task-queue
temporal task-queue
Task Queue
Learn more - --tls
temporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-path
temporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-path
temporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verification
temporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-path
temporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-name
temporal tls-server-name
Overrides the target TLS server name.
Learn more
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
temporal address
The host and port for the Temporal Frontend Service.
Learn more - --build-id
temporal build-id
Identifies the Build.
Learn more - --codec-auth
temporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpoint
temporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --color
temporal color
Color options for the CLI.
Learn more - --context-timeout
temporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --env
temporal env
Name of the environment to read environmental variables from.
Learn more - --grpc-meta
temporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --namespace
temporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --reachability-type
temporal reachability-type
Specify how you'd like to filter the reachability of Build IDs
Learn more - --task-queue
temporal task-queue
Task Queue
Learn more - --tls
temporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-path
temporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-path
temporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verification
temporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-path
temporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-name
temporal tls-server-name
Overrides the target TLS server name.
Learn more
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.