Update CLI docs for release v1.9.0 - #5313
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0e33e81770
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| Nexus Operation commands follow this syntax: | ||
|
|
||
| ``` | ||
| temporal nexus operation [command] [options] |
There was a problem hiding this comment.
Replace the prerelease Nexus CLI prerequisites
With this v1.9 reference adding temporal nexus operation to the standard CLI command set, docs/encyclopedia/nexus/standalone-nexus-operation.mdx (lines 126-162) and the Go, TypeScript, Java, Python, and .NET docs/develop/*/nexus/standalone-operations.mdx guides still require the special v1.7.4 prerelease binary and warn that brew install temporal lacks 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 👍 / 👎.
| To target a standalone Activity, specify the Activity and Run IDs: | ||
|
|
||
| ``` | ||
| temporal activity pause \ | ||
| --activity-id YourActivityId \ | ||
| --run-id YourRunId |
There was a problem hiding this comment.
Cover Standalone Activities in the operations guide
This example establishes that Pause can now target a Standalone Activity, and the same update extends Reset, Unpause, and Update Options, but docs/encyclopedia/activities/activity-operations.mdx lines 24-26 still categorically state that Activity Operations do not apply to Standalone Activities and the subsequent guidance assumes a parent Workflow. Revise that page's scope, examples, limitations, and version requirements to distinguish Standalone Activities from Workflow Activities.
AGENTS.md reference: AGENTS.md:L235-L243
Useful? React with 👍 / 👎.
| | `--activity-id`, `-a` | No | **string** The Activity ID to reset. Mutually exclusive with `--query`. Set `--workflow-id` to target a workflow Activity, or omit it to target a standalone Activity (the latest run unless `--run-id` is set). | | ||
| | `--clear-heartbeat-details` | No | **bool** Clear the Activity's heartbeat details. | |
There was a problem hiding this comment.
Remove the retired Activity reset flags
The generated v1.9 help now exposes --clear-heartbeat-details for Reset and no longer exposes --reset-heartbeats or --reset-attempts, but docs/encyclopedia/activities/activity-operations.mdx lines 137-152, 187, 219-220, and 242-243 repeatedly recommend the removed flags for Unpause and Reset. Commands copied from that guide will therefore use unsupported options; replace the Reset references with --clear-heartbeat-details and remove or revise the Unpause advice.
AGENTS.md reference: AGENTS.md:L235-L243
Useful? React with 👍 / 👎.
Autogenerated PR from https://github.com/temporalio/cli