You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cli/activity.mdx
+35-35Lines changed: 35 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,28 @@
1
-
{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
2
-
This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
3
-
---
1
+
## {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
2
+
4
3
id: activity
5
4
title: Temporal CLI activity command reference
6
5
sidebar_label: activity
7
6
description: Learn how to use Temporal Activity commands for completing or failing Activity Executions in your Workflow. Optimize your Temporal Workflow management effectively.
8
7
toc_max_heading_level: 4
9
8
keywords:
10
-
- activity
11
-
- activity complete
12
-
- activity update-options
13
-
- activity pause
14
-
- activity unpause
15
-
- activity reset
16
-
- activity execution
17
-
- activity fail
18
-
- cli reference
19
-
- cli-feature
20
-
- command-line-interface-cli
21
-
- temporal cli
22
-
tags:
23
-
- Activities
24
-
- Temporal CLI
9
+
10
+
- activity
11
+
- activity complete
12
+
- activity update-options
13
+
- activity pause
14
+
- activity unpause
15
+
- activity reset
16
+
- activity execution
17
+
- activity fail
18
+
- cli reference
19
+
- cli-feature
20
+
- command-line-interface-cli
21
+
- temporal cli
22
+
tags:
23
+
- Activities
24
+
- Temporal CLI
25
+
25
26
---
26
27
27
28
## complete
@@ -374,7 +375,7 @@ Pause an Activity.
374
375
If the Activity is not currently running (e.g. because it previously
375
376
failed), it will not be run again until it is unpaused.
376
377
377
-
However, if the Activity is currently running, it will run until the next
378
+
However, if the Activity is currently running, it will run until the next
378
379
time it fails, completes, or times out, at which point the pause will kick in.
379
380
380
381
If the Activity is on its last retry attempt and fails, the failure will
@@ -390,7 +391,7 @@ temporal activity pause \
390
391
--workflow-id YourWorkflowId
391
392
```
392
393
393
-
To later unpause the activity, see [unpause](#unpause). You may also want to
394
+
To later unpause the activity, see [unpause](#unpause). You may also want to
394
395
[reset](#reset) the activity to unpause it while also starting it from the beginning.
395
396
396
397
Use the following options to change the behavior of this command.
@@ -553,31 +554,31 @@ Override target TLS server name.
553
554
554
555
## reset
555
556
556
-
Reset an activity. This restarts the activity as if it were first being
557
-
scheduled. That is, it will reset both the number of attempts and the
558
-
activity timeout, as well as, optionally, the
557
+
Reset an activity. This restarts the activity as if it were first being
558
+
scheduled. That is, it will reset both the number of attempts and the
559
+
activity timeout, as well as, optionally, the
559
560
[heartbeat details](#reset-heartbeats).
560
561
561
-
If the activity may be executing (i.e. it has not yet timed out), the
562
+
If the activity may be executing (i.e. it has not yet timed out), the
562
563
reset will take effect the next time it fails, heartbeats, or times out.
563
-
If is waiting for a retry (i.e. has failed or timed out), the reset
564
+
If is waiting for a retry (i.e. has failed or timed out), the reset
564
565
will apply immediately.
565
566
566
-
If the activity is already paused, it will be unpaused by default.
567
+
If the activity is already paused, it will be unpaused by default.
567
568
You can specify `keep_paused` to prevent this.
568
569
569
-
If the activity is paused and the `keep_paused` flag is not provided,
570
-
it will be unpaused. If the activity is paused and `keep_paused` flag
570
+
If the activity is paused and the `keep_paused` flag is not provided,
571
+
it will be unpaused. If the activity is paused and `keep_paused` flag
571
572
is provided - it will stay paused.
572
573
573
574
Activities can be specified by their Activity ID or Activity Type.
574
575
575
576
### Resetting activities that heartbeat {#reset-heartbeats}
576
577
577
-
Activities that heartbeat will receive a [Canceled failure](/references/failures#cancelled-failure)
578
+
Activities that heartbeat will receive a [Canceled failure](/references/failures#cancelled-failure)
578
579
the next time they heartbeat after a reset.
579
580
580
-
If, in your Activity, you need to do any cleanup when an Activity is
581
+
If, in your Activity, you need to do any cleanup when an Activity is
581
582
reset, handle this error and then re-throw it when you've cleaned up.
582
583
583
584
If the `reset_heartbeats` flag is set, the heartbeat details will also be cleared.
@@ -786,8 +787,8 @@ temporal activity unpause \
786
787
--reset-heartbeats
787
788
```
788
789
789
-
Activities can be unpaused in bulk via a visibility Query list filter.
790
-
For example, if you want to unpause activities of type Foo that you
790
+
Activities can be unpaused in bulk via a visibility Query list filter.
791
+
For example, if you want to unpause activities of type Foo that you
791
792
previously paused, do:
792
793
793
794
```
@@ -996,8 +997,8 @@ Override target TLS server name.
996
997
## update-options
997
998
998
999
Update the options of a running Activity that were passed into it from
999
-
a Workflow. Updates are incremental, only changing the specified
1000
-
options.
1000
+
a Workflow. Updates are incremental, only changing the specified
1001
+
options.
1001
1002
1002
1003
For example:
1003
1004
@@ -1207,4 +1208,3 @@ Path to x509 private key. Can't be used with --tls-key-data.
Copy file name to clipboardExpand all lines: docs/cli/batch.mdx
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,23 @@
1
-
{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
2
-
This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
3
-
---
1
+
## {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
2
+
4
3
id: batch
5
4
title: Temporal CLI batch command reference
6
5
sidebar_label: batch
7
6
description: Use Temporal CLI to manage multiple Workflow Executions with Batch Jobs that can Cancel, Signal, or Terminate Workflows. Filter and monitor Batch Jobs effectively.
8
7
toc_max_heading_level: 4
9
8
keywords:
10
-
- batch
11
-
- batch describe
12
-
- batch list
13
-
- batch terminate
14
-
- cli reference
15
-
- cli-feature
16
-
- command-line-interface-cli
17
-
- temporal cli
18
-
tags:
19
-
- Temporal CLI
9
+
10
+
- batch
11
+
- batch describe
12
+
- batch list
13
+
- batch terminate
14
+
- cli reference
15
+
- cli-feature
16
+
- command-line-interface-cli
17
+
- temporal cli
18
+
tags:
19
+
- Temporal CLI
20
+
20
21
---
21
22
22
23
## describe
@@ -504,4 +505,3 @@ Path to x509 private key. Can't be used with --tls-key-data.
Copy file name to clipboardExpand all lines: docs/cli/config.mdx
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,25 @@
1
-
{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
2
-
This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
3
-
---
1
+
## {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
2
+
4
3
id: config
5
4
title: Temporal CLI config command reference
6
5
sidebar_label: config
7
6
description: Temporal CLI 'config' commands allow the getting, setting, deleting, and listing of configuration properties for connecting to Temporal.
8
7
toc_max_heading_level: 4
9
8
keywords:
10
-
- cli reference
11
-
- command-line-interface-cli
12
-
- configuration
13
-
- config
14
-
- config delete
15
-
- config get
16
-
- config list
17
-
- config set
18
-
- environment
19
-
- temporal cli
20
-
tags:
21
-
- Temporal CLI
9
+
10
+
- cli reference
11
+
- command-line-interface-cli
12
+
- configuration
13
+
- config
14
+
- config delete
15
+
- config get
16
+
- config list
17
+
- config set
18
+
- environment
19
+
- temporal cli
20
+
tags:
21
+
- Temporal CLI
22
+
22
23
---
23
24
24
25
## delete
@@ -813,4 +814,3 @@ Path to x509 private key. Can't be used with --tls-key-data.
Copy file name to clipboardExpand all lines: docs/cli/env.mdx
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,25 @@
1
-
{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
2
-
This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
3
-
---
1
+
## {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
2
+
4
3
id: env
5
4
title: Temporal CLI env command reference
6
5
sidebar_label: env
7
6
description: Temporal CLI 'env' commands allow the configuration, setting, deleting, and listing of environmental properties, making it easy to manage Temporal Server instances.
8
7
toc_max_heading_level: 4
9
8
keywords:
10
-
- cli reference
11
-
- command-line-interface-cli
12
-
- configuration
13
-
- env
14
-
- env delete
15
-
- env get
16
-
- env list
17
-
- env set
18
-
- environment
19
-
- temporal cli
20
-
tags:
21
-
- Temporal CLI
9
+
10
+
- cli reference
11
+
- command-line-interface-cli
12
+
- configuration
13
+
- env
14
+
- env delete
15
+
- env get
16
+
- env list
17
+
- env set
18
+
- environment
19
+
- temporal cli
20
+
tags:
21
+
- Temporal CLI
22
+
22
23
---
23
24
24
25
## delete
@@ -682,4 +683,3 @@ Path to x509 private key. Can't be used with --tls-key-data.
Copy file name to clipboardExpand all lines: docs/cli/operator.mdx
+35-35Lines changed: 35 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,42 +1,43 @@
1
-
{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
2
-
This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
3
-
---
1
+
## {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
2
+
4
3
id: operator
5
4
title: Temporal CLI operator command reference
6
5
sidebar_label: operator
7
6
description: Operator commands in Temporal allow actions on Namespaces, Search Attributes, Clusters and Nexus Endpoints using specific subcommands. Execute with "temporal operator [command][subcommand][options]".
8
7
toc_max_heading_level: 4
9
8
keywords:
10
-
- cli reference
11
-
- cluster
12
-
- cluster health
13
-
- cluster list
14
-
- cluster remove
15
-
- cluster upsert
16
-
- command-line-interface-cli
17
-
- describe
18
-
- namespace
19
-
- namespace create
20
-
- namespace delete
21
-
- namespace describe
22
-
- namespace list
23
-
- nexus
24
-
- nexus endpoint
25
-
- nexus endpoint create
26
-
- nexus endpoint delete
27
-
- nexus endpoint get
28
-
- nexus endpoint list
29
-
- nexus endpoint update
30
-
- operator
31
-
- search attribute
32
-
- search attribute create
33
-
- search attribute list
34
-
- search attribute remove
35
-
- system
36
-
- temporal cli
37
-
- update
38
-
tags:
39
-
- Temporal CLI
9
+
10
+
- cli reference
11
+
- cluster
12
+
- cluster health
13
+
- cluster list
14
+
- cluster remove
15
+
- cluster upsert
16
+
- command-line-interface-cli
17
+
- describe
18
+
- namespace
19
+
- namespace create
20
+
- namespace delete
21
+
- namespace describe
22
+
- namespace list
23
+
- nexus
24
+
- nexus endpoint
25
+
- nexus endpoint create
26
+
- nexus endpoint delete
27
+
- nexus endpoint get
28
+
- nexus endpoint list
29
+
- nexus endpoint update
30
+
- operator
31
+
- search attribute
32
+
- search attribute create
33
+
- search attribute list
34
+
- search attribute remove
35
+
- system
36
+
- temporal cli
37
+
- update
38
+
tags:
39
+
- Temporal CLI
40
+
40
41
---
41
42
42
43
## cluster
@@ -1034,7 +1035,7 @@ Create a new Namespace on the Temporal Service:
1034
1035
temporal operator namespace create \
1035
1036
--namespace YourNewNamespaceName \
1036
1037
[options]
1037
-
````
1038
+
```
1038
1039
1039
1040
Create a Namespace with multi-region data replication:
1040
1041
@@ -3351,4 +3352,3 @@ Path to x509 private key. Can't be used with --tls-key-data.
0 commit comments