add temporal cli docs for nexus endpoints (#3149)

* add temporal cli docs for nexus endpoints Signed-off-by: Phil Prasek <[email protected]> * adjust front matter Signed-off-by: Phil Prasek <[email protected]> * add missing command options Signed-off-by: Phil Prasek <[email protected]> * running yarn format on file * putting one sentence on one line and capitalizing Temporal terms * capitalize Temporal terms Signed-off-by: Phil Prasek <[email protected]> * mark `nexus endpoint create --target-url` flag experimental Signed-off-by: Phil Prasek <[email protected]> * address feedback Signed-off-by: Phil Prasek <[email protected]> * copy edit changes Signed-off-by: Phil Prasek <[email protected]> * running yarn format and removing duplicate note under target-url --------- Signed-off-by: Phil Prasek <[email protected]> Co-authored-by: Jwahir Sundai <[email protected]>
temporalio · Oct 16, 2024 · e74a60c · e74a60c
1 parent 2050cb5
commit e74a60c
Show file tree

Hide file tree

Showing 2 changed files with 421 additions and 3 deletions.
diff --git a/docs/cli/cmd-options.mdx b/docs/cli/cmd-options.mdx
@@ -234,13 +234,17 @@ Identifies the Activity Execution.
 
 The host and port (formatted as host:port) for the Temporal Frontend Service.
 
+## api-key
+
+API key for request.
+
 ## archived
 
 List archived Workflow Executions.
 
 :::note
 
-Currently an experimental feature.
+Caution: `--archived` is experimental.
 
 :::
 
@@ -313,7 +317,13 @@ Use `-1` to fetch Child Workflows at any depth.
 
 ## description
 
-Namespace description.
+Namespace description or Nexus Endpoint description.
+You may use Markdown formatting in the Nexus Endpoint description.
+
+## description-file
+
+Path to the Nexus Endpoint description file.
+The contents of the description file may use Markdown formatting.
 
 ## detail
 
@@ -344,6 +354,11 @@ Backfill end time.
 
 Name of the environment to read environmental variables from.
 
+## env-file
+
+Path to environment settings file.
+Defaults to `$HOME/.config/temporalio/temporal.yaml`.
+
 ## event-id
 
 The Event Id for any Event after WorkflowTaskStarted you want to reset to (exclusive).
@@ -503,7 +518,7 @@ Enabled by default with a randomly assigned port.
 
 ## name
 
-Frontend address of the remote Cluster.
+Frontend address of the remote Cluster or the Endpoint name.
 
 ## namespace
 
@@ -518,6 +533,10 @@ Namespace Id.
 Disable folding.
 All Child Workflows within the set depth will be fetched and displayed.
 
+## no-json-shorthand-payloads
+
+Raw payload output, even if the JSON option was used.
+
 ## no-pager
 
 Disables the interactive pager.
@@ -656,6 +675,25 @@ Specify a delay before the workflow starts.
 
 Backfill start time.
 
+## target-namespace
+
+Namespace in which a handler Worker will poll for Nexus tasks.
+
+## target-task-queue
+
+Task Queue in which a handler Worker will poll for Nexus tasks.
+
+## target-url
+
+An external Nexus Endpoint where Nexus requests are forwarded to.
+May be used as an alternative to `--target-namespace` and `--target-task-queue`.
+
+:::note
+
+Caution: `--target-url` is experimental.
+
+:::
+
 ## task-queue-type
 
 Task Queue type, which can be either workflow or activity.
@@ -677,10 +715,18 @@ Format time as: relative, iso, raw.
 
 Time zone (IANA name).
 
+## tls-ca-data
+
+Data for server CA certificate. Can't be used with --tls-ca-path.
+
 ## tls-ca-path
 
 Path to server CA certificate.
 
+## tls-cert-data
+
+Data for x509 certificate. Can't be used with --tls-cert-path.
+
 ## tls-cert-path
 
 Path to x509 certificate.
@@ -689,6 +735,10 @@ Path to x509 certificate.
 
 Disables TLS host name verification.
 
+## tls-key-data
+
+Private certificate key data. Can't be used with --tls-key-path.
+
 ## tls-key-path
 
 Path to private certificate key.
@@ -727,6 +777,10 @@ Default: `--port` + 1000 (for example, 4000).
 
 Unpauses the Schedule.
 
+## unset-description
+
+Unset the description.
+
 ## verbose
 
 Print applied Namespace changes.