Temporal CLI activity command reference

Activity commands operate on Activity Executions 🔗

x

Link preview

What is an Activity Execution?

An Activity Execution is the full chain of Activity Task Executions.

term explanation

.

To run an Activity command, type temporal activity [command] [command options]

complete

The temporal activity complete command completes an Activity Execution 🔗

x

Link preview

What is an Activity Execution?

An Activity Execution is the full chain of Activity Task Executions.

term explanation

. 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 options listed below to change the behavior of this command.

• --activity-id 🔗

  x

  Link preview

  temporal activity-id

  Identifies the Activity Execution.

  cli reference temporal cli activity id activity activity execution options-feature command-line-interface-cli

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --identity 🔗

  x

  Link preview

  temporal identity

  Specify operator's identity.

  cli reference temporal cli options-feature command-line-interface-cli operator

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --result 🔗

  x

  Link preview

  temporal result

  Set the result value of Activity completion.

  cli reference temporal cli options-feature command-line-interface-cli activity execution

• --run-id 🔗

  x

  Link preview

  temporal run-id

  Identifies the current Workflow Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id

fail

The temporal activity fail command fails an Activity Execution 🔗

x

Link preview

What is an Activity Execution?

An Activity Execution is the full chain of Activity Task Executions.

term explanation

. The Activity must already be running on a valid Workflow 🔗

x

Link preview

What is a Workflow?

In day-to-day conversations, the term "Workflow" frequently denotes either a Workflow Type, a Workflow Definition, or a Workflow Execution.

term explanation

. temporal fail --workflow-id=meaningful-business-id --activity-id=MyActivity

Use the options listed below to change the behavior of this command.

• --activity-id 🔗

  x

  Link preview

  temporal activity-id

  Identifies the Activity Execution.

  cli reference temporal cli activity id activity activity execution options-feature command-line-interface-cli

• --detail 🔗

  x

  Link preview

  temporal detail

  Detail to fail the Activity.

  cli reference temporal cli options-feature command-line-interface-cli activity failures

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --identity 🔗

  x

  Link preview

  temporal identity

  Specify operator's identity.

  cli reference temporal cli options-feature command-line-interface-cli operator

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --reason 🔗

  x

  Link preview

  temporal reason

  Reason for the operation

  cli reference temporal cli options-feature command-line-interface-cli operation

• --run-id 🔗

  x

  Link preview

  temporal run-id

  Identifies the current Workflow Run.

  cli reference temporal cli options-feature command-line-interface-cli workflow run

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

• --workflow-id 🔗

  x

  Link preview

  temporal workflow-id

  Workflow Id

  cli reference temporal cli options-feature command-line-interface-cli workflow id