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.
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.
Use the options listed below to change the behavior of this command.
Make sure to write the command as follows:
temporal activity complete [command options]
- --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
When to use color
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 - --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
Provides an override for 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.
Use the options listed below to change the behavior of this command.
Make sure to write the command as follows:
temporal activity fail [command options]
- --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
When to use color
Learn more - --context-timeouttemporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --detailtemporal detail
Detail 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 - --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
Provides an override for the target TLS server name.
Learn more - --workflow-idtemporal workflow-id
Workflow Id
Learn more