-
Notifications
You must be signed in to change notification settings - Fork 328
Update CLI docs for release v1.9.0 #5313
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
github-actions
wants to merge
1
commit into
main
Choose a base branch
from
update-cli-docs-v1.9.0
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,247 @@ | ||
| --- | ||
| id: nexus | ||
| title: Temporal CLI nexus command reference | ||
| sidebar_label: nexus | ||
| description: Learn how to use Temporal Nexus commands for starting, listing, and managing Nexus Operation Executions. | ||
| toc_max_heading_level: 4 | ||
| tags: | ||
| - Nexus | ||
| - Temporal CLI | ||
| --- | ||
|
|
||
| {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. | ||
| This file is generated from the CLI command definitions via cmd/gen-docs. */} | ||
|
|
||
| This page provides a reference for the `temporal` CLI `nexus` command. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. | ||
|
|
||
| ## operation | ||
|
|
||
| These commands manage Nexus Operation Executions. | ||
|
|
||
| Nexus Operation commands follow this syntax: | ||
|
|
||
| ``` | ||
| temporal nexus operation [command] [options] | ||
| ``` | ||
|
|
||
| ### cancel | ||
|
|
||
| Request cancellation of a Nexus Operation. | ||
|
|
||
| ``` | ||
| temporal nexus operation cancel \ | ||
| --operation-id YourOperationId | ||
| ``` | ||
|
|
||
| The Operation handler determines how to handle the | ||
| cancellation request. | ||
|
|
||
| Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. | ||
|
|
||
| | Flag | Required | Description | | ||
| |------|----------|-------------| | ||
| | `--operation-id` | Yes | **string** Nexus Operation ID. | | ||
| | `--reason` | No | **string** Reason for cancellation. | | ||
| | `--run-id`, `-r` | No | **string** Run ID of the Nexus Operation. | | ||
|
|
||
| ### count | ||
|
|
||
| Return a count of Nexus Operations. Use `--query` | ||
| to filter the operations to be counted. | ||
|
|
||
| ``` | ||
| temporal nexus operation count \ | ||
| --query 'Endpoint="YourEndpoint"' | ||
| ``` | ||
|
|
||
| Visit https://docs.temporal.io/visibility to read more about | ||
| Search Attributes and queries. | ||
|
|
||
| Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. | ||
|
|
||
| | Flag | Required | Description | | ||
| |------|----------|-------------| | ||
| | `--query`, `-q` | No | **string** Query to filter Nexus Operation Executions to count. | | ||
|
|
||
| ### describe | ||
|
|
||
| Display detailed information about a specific Nexus | ||
| Operation Execution. | ||
|
|
||
| ``` | ||
| temporal nexus operation describe \ | ||
| --operation-id YourOperationId | ||
| ``` | ||
|
|
||
| Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. | ||
|
|
||
| | Flag | Required | Description | | ||
| |------|----------|-------------| | ||
| | `--operation-id` | Yes | **string** Nexus Operation ID. | | ||
| | `--raw` | No | **bool** Print properties without changing their format. | | ||
| | `--run-id`, `-r` | No | **string** Run ID of the Nexus Operation. | | ||
|
|
||
| ### execute | ||
|
|
||
| Start a new Nexus Operation Execution and block until | ||
| it completes. The result is output to stdout. | ||
|
|
||
| ``` | ||
| temporal nexus operation execute \ | ||
| --endpoint YourEndpoint \ | ||
| --service YourService \ | ||
| --operation YourOperation \ | ||
| --operation-id YourOperationId \ | ||
| --input '{"some-key": "some-value"}' | ||
| ``` | ||
|
|
||
| Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. | ||
|
|
||
| | Flag | Required | Description | | ||
| |------|----------|-------------| | ||
| | `--endpoint` | Yes | **string** Nexus Endpoint name. | | ||
| | `--id-conflict-policy` | No | **string-enum** Policy for handling an Operation ID conflict with a running operation. Accepted values: Fail, UseExisting, TerminateExisting. | | ||
| | `--id-reuse-policy` | No | **string-enum** Policy for re-using an Operation ID from a previously closed operation. Accepted values: AllowDuplicate, RejectDuplicate. | | ||
| | `--input`, `-i` | No | **string[]** Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. | | ||
| | `--input-base64` | No | **bool** Assume inputs are base64-encoded and attempt to decode them. | | ||
| | `--input-file` | No | **string[]** A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. | | ||
| | `--input-meta` | No | **string[]** Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. | | ||
| | `--operation` | Yes | **string** Nexus Operation name. | | ||
| | `--operation-id` | Yes | **string** Nexus Operation ID. | | ||
| | `--schedule-to-close-timeout` | No | **duration** Total time the operation is allowed to run. | | ||
| | `--schedule-to-start-timeout` | No | **duration** Maximum time to wait for an operation to be started (or completed synchronously) by a handler. | | ||
| | `--search-attribute` | No | **string[]** Search Attribute in `KEY=VALUE` format. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. | | ||
| | `--service` | Yes | **string** Nexus Service name. | | ||
| | `--start-to-close-timeout` | No | **duration** Maximum time to wait for an asynchronous operation to complete after it has been started. | | ||
| | `--static-summary` | No | **string** Static summary for the Nexus Operation for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. _(Experimental)_ | | ||
|
|
||
| ### list | ||
|
|
||
| List Nexus Operations. Use `--query` to filter results. | ||
|
|
||
| ``` | ||
| temporal nexus operation list \ | ||
| --query 'Endpoint="YourEndpoint"' | ||
| ``` | ||
|
|
||
| Visit https://docs.temporal.io/visibility to read more about | ||
| Search Attributes and queries. | ||
|
|
||
| Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. | ||
|
|
||
| | Flag | Required | Description | | ||
| |------|----------|-------------| | ||
| | `--limit` | No | **int** Maximum number of Nexus Operation Executions to display. | | ||
| | `--page-size` | No | **int** Maximum number of Nexus Operation Executions to fetch at a time from the server. | | ||
| | `--query`, `-q` | No | **string** Query to filter the Nexus Operation Executions to list. | | ||
|
|
||
| ### result | ||
|
|
||
| Wait for a Nexus Operation to complete and output | ||
| the result. | ||
|
|
||
| ``` | ||
| temporal nexus operation result \ | ||
| --operation-id YourOperationId | ||
| ``` | ||
|
|
||
| Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. | ||
|
|
||
| | Flag | Required | Description | | ||
| |------|----------|-------------| | ||
| | `--operation-id` | Yes | **string** Nexus Operation ID. | | ||
| | `--run-id`, `-r` | No | **string** Run ID of the Nexus Operation. | | ||
|
|
||
| ### start | ||
|
|
||
| Start a new Nexus Operation. Outputs the | ||
| Operation ID and Run ID. | ||
|
|
||
| ``` | ||
| temporal nexus operation start \ | ||
| --endpoint YourEndpoint \ | ||
| --service YourService \ | ||
| --operation YourOperation \ | ||
| --operation-id YourOperationId \ | ||
| --input '{"some-key": "some-value"}' | ||
| ``` | ||
|
|
||
| Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. | ||
|
|
||
| | Flag | Required | Description | | ||
| |------|----------|-------------| | ||
| | `--endpoint` | Yes | **string** Nexus Endpoint name. | | ||
| | `--id-conflict-policy` | No | **string-enum** Policy for handling an Operation ID conflict with a running operation. Accepted values: Fail, UseExisting, TerminateExisting. | | ||
| | `--id-reuse-policy` | No | **string-enum** Policy for re-using an Operation ID from a previously closed operation. Accepted values: AllowDuplicate, RejectDuplicate. | | ||
| | `--input`, `-i` | No | **string[]** Input value. Use JSON content or set --input-meta to override. Can't be combined with --input-file. Can be passed multiple times to pass multiple arguments. | | ||
| | `--input-base64` | No | **bool** Assume inputs are base64-encoded and attempt to decode them. | | ||
| | `--input-file` | No | **string[]** A path or paths for input file(s). Use JSON content or set --input-meta to override. Can't be combined with --input. Can be passed multiple times to pass multiple arguments. | | ||
| | `--input-meta` | No | **string[]** Input payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. Repeated metadata keys are applied to the corresponding inputs in the provided order. | | ||
| | `--operation` | Yes | **string** Nexus Operation name. | | ||
| | `--operation-id` | Yes | **string** Nexus Operation ID. | | ||
| | `--schedule-to-close-timeout` | No | **duration** Total time the operation is allowed to run. | | ||
| | `--schedule-to-start-timeout` | No | **duration** Maximum time to wait for an operation to be started (or completed synchronously) by a handler. | | ||
| | `--search-attribute` | No | **string[]** Search Attribute in `KEY=VALUE` format. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. | | ||
| | `--service` | Yes | **string** Nexus Service name. | | ||
| | `--start-to-close-timeout` | No | **duration** Maximum time to wait for an asynchronous operation to complete after it has been started. | | ||
| | `--static-summary` | No | **string** Static summary for the Nexus Operation for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. _(Experimental)_ | | ||
|
|
||
| ### terminate | ||
|
|
||
| Terminate a Nexus Operation. | ||
|
|
||
| ``` | ||
| temporal nexus operation terminate \ | ||
| --operation-id YourOperationId \ | ||
| --reason YourReason | ||
| ``` | ||
|
|
||
| Operation handlers cannot see or respond to terminations. | ||
|
|
||
| Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands. | ||
|
|
||
| | Flag | Required | Description | | ||
| |------|----------|-------------| | ||
| | `--operation-id` | Yes | **string** Nexus Operation ID. | | ||
| | `--reason` | No | **string** Reason for termination. Defaults to a message with the current user's name. | | ||
| | `--run-id`, `-r` | No | **string** Run ID of the Nexus Operation. | | ||
|
|
||
| ## Global Flags | ||
|
|
||
| The following options can be used with any command. | ||
|
|
||
| | Flag | Required | Description | Default | | ||
| |------|----------|-------------|--------| | ||
| | `--address` | No | **string** Temporal Service gRPC endpoint. | `localhost:7233` | | ||
| | `--api-key` | No | **string** API key for request. | | | ||
| | `--client-authority` | No | **string** Temporal gRPC client :authority pseudoheader. | | | ||
| | `--client-connect-timeout` | No | **duration** Client connection timeout. | | | ||
| | `--codec-auth` | No | **string** Authorization header for Codec Server requests. | | | ||
| | `--codec-endpoint` | No | **string** Remote Codec Server endpoint. | | | ||
| | `--codec-header` | No | **string[]** HTTP headers for codec server (KEY=VALUE, repeatable). | | | ||
| | `--color` | No | **string-enum** Output coloring. Accepted values: always, never, auto. | `auto` | | ||
| | `--command-timeout` | No | **duration** Command execution timeout. | | | ||
| | `--config-file` | No | **string** TOML config file path. | | | ||
| | `--disable-config-env` | No | **bool** Disable loading config from environment variables. | | | ||
| | `--disable-config-file` | No | **bool** Disable loading config from file. | | | ||
| | `--env` | No | **string** Active environment name (`ENV`). | `default` | | ||
| | `--env-file` | No | **string** Path to environment settings file. | | | ||
| | `--grpc-meta` | No | **string[]** HTTP headers for requests (KEY=VALUE, repeatable). | | | ||
| | `--identity` | No | **string** Identity of the client submitting requests. | | | ||
| | `--log-format` | No | **string-enum** Log format. Accepted values: text, json. | `text` | | ||
| | `--log-level` | No | **string-enum** Log level. Default is "never" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. | `never` | | ||
| | `--namespace`, `-n` | No | **string** Temporal Service Namespace. | `default` | | ||
| | `--no-json-shorthand-payloads` | No | **bool** Raw payload output, even if the JSON option was used. | | | ||
| | `--output`, `-o` | No | **string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. | `text` | | ||
| | `--profile` | No | **string** Configuration profile to use. Overrides the TEMPORAL_PROFILE environment variable and defaults to "default". | | | ||
| | `--time-format` | No | **string-enum** Time format. Accepted values: relative, iso, raw. | `relative` | | ||
| | `--tls` | No | **bool** Enable base TLS encryption. Auto-enabled when api-key or TLS options are set. | | | ||
| | `--tls-ca-data` | No | **string** Inline server CA certificate data. | | | ||
| | `--tls-ca-path` | No | **string** Path to server CA certificate. | | | ||
| | `--tls-cert-data` | No | **string** Inline x509 certificate data. | | | ||
| | `--tls-cert-path` | No | **string** Path to x509 certificate. | | | ||
| | `--tls-disable-host-verification` | No | **bool** Disable TLS host-name verification. | | | ||
| | `--tls-key-data` | No | **string** Inline x509 private key data. | | | ||
| | `--tls-key-path` | No | **string** Path to x509 private key. | | | ||
| | `--tls-server-name` | No | **string** Override target TLS server name. | | | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With this v1.9 reference adding
temporal nexus operationto the standard CLI command set,docs/encyclopedia/nexus/standalone-nexus-operation.mdx(lines 126-162) and the Go, TypeScript, Java, Python, and .NETdocs/develop/*/nexus/standalone-operations.mdxguides still require the special v1.7.4 prerelease binary and warn thatbrew install temporallacks the command. Those prerequisites now direct every SDK reader to an obsolete artifact; update the overview and all five guides to require the standard v1.9+ CLI while retaining the feature's separate prerelease caveat.AGENTS.md reference: AGENTS.md:L235-L243
Useful? React with 👍 / 👎.