Temporal CLI activity command reference
Activity commands operate on Activity Executions
What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
Activity commands follow this syntax:
temporal activity [command] [command options]
complete
The temporal activity complete command completes an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
Along with completing the Activity, the result given upon return can be set as well.
temporal activity complete --activity-id=MyActivity --result=ActivityComplete
Use the following options to change the behavior of this command.
- --activity-idtemporal activity-id
Identifies the Activity Execution.
Learn more - --addresstemporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-authtemporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpointtemporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --colortemporal color
Color options for the CLI.
Learn more - --context-timeouttemporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --envtemporal env
Name of the environment to read environmental variables from.
Learn more - --grpc-metatemporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --identitytemporal identity
Specify operator's identity.
Learn more - --namespacetemporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --resulttemporal result
Set the result value of Activity completion.
Learn more - --run-idtemporal run-id
Identifies the current Workflow Run.
Learn more - --tlstemporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-pathtemporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-pathtemporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verificationtemporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-pathtemporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-nametemporal tls-server-name
Overrides the target TLS server name.
Learn more - --workflow-idtemporal workflow-id
Workflow Id
Learn more
fail
The temporal activity fail command fails an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
The Activity must already be running on a valid WorkflowWhat is a Workflow?
In day-to-day conversations, the term "Workflow" frequently denotes either a Workflow Type, a Workflow Definition, or a Workflow Execution.
Learn more.
temporal fail --workflow-id=meaningful-business-id --activity-id=MyActivity
Use the following options to change the behavior of this command.
- --activity-idtemporal activity-id
Identifies the Activity Execution.
Learn more - --addresstemporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-authtemporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpointtemporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --colortemporal color
Color options for the CLI.
Learn more - --context-timeouttemporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --detailtemporal detail
Reason to fail the Activity.
Learn more - --envtemporal env
Name of the environment to read environmental variables from.
Learn more - --grpc-metatemporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --identitytemporal identity
Specify operator's identity.
Learn more - --namespacetemporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --reasontemporal reason
Reason for the operation
Learn more - --run-idtemporal run-id
Identifies the current Workflow Run.
Learn more - --tlstemporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-pathtemporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-pathtemporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verificationtemporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-pathtemporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-nametemporal tls-server-name
Overrides the target TLS server name.
Learn more - --workflow-idtemporal workflow-id
Workflow Id
Learn more