Update CLI docs for release v1.8.0#4864
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
docs/cli/command-reference/cloud/namespace.mdx|1019 col 6| [Temporal.Headings] 'mtls cert-ca create' should use sentence-style capitalization.
docs/cli/command-reference/cloud/namespace.mdx|1054 col 6| [Temporal.Headings] 'mtls cert-ca delete' should use sentence-style capitalization.
docs/cli/command-reference/cloud/namespace.mdx|1089 col 6| [Temporal.Headings] 'mtls cert-ca list' should use sentence-style capitalization.
docs/cli/command-reference/cloud/namespace.mdx|1108 col 5| [Temporal.Headings] 'mtls cert-filter' should use sentence-style capitalization.
docs/cli/command-reference/cloud/namespace.mdx|1114 col 6| [Temporal.Headings] 'mtls cert-filter create' should use sentence-style capitalization.
docs/cli/command-reference/cloud/namespace.mdx|1137 col 6| [Temporal.Headings] 'mtls cert-filter delete' should use sentence-style capitalization.
docs/cli/command-reference/cloud/namespace.mdx|1159 col 6| [Temporal.Headings] 'mtls cert-filter list' should use sentence-style capitalization.
docs/cli/command-reference/cloud/namespace.mdx|1171 col 5| [Temporal.Headings] 'mtls disable' should use sentence-style capitalization.
docs/cli/command-reference/cloud/namespace.mdx|1194 col 5| [Temporal.Headings] 'mtls enable' should use sentence-style capitalization.
docs/cli/command-reference/cloud/namespace.mdx|1217 col 5| [Temporal.Headings] 'mtls get' should use sentence-style capitalization.
docs/cli/command-reference/cloud/namespace.mdx|1235 col 4| [Temporal.Headings] 'retention' should use sentence-style capitalization.
| | `--redirect-url` | No | **string** Redirect URL for OAuth authentication flow. | | ||
| | `--reset` | No | **bool** Clear stored login credentials and configuration, then re-authenticate. Use this if you need to switch accounts or fix authentication issues. | | ||
|
|
||
| ## Global Flags |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Global Flags' should use sentence-style capitalization.
| |------|----------|-------------| | ||
| | `--domain` | No | **string** Authentication domain for the OAuth provider. | | ||
|
|
||
| ## Global Flags |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Global Flags' should use sentence-style capitalization.
| @@ -87,12 +85,20 @@ Commands for managing private connectivity rules. | |||
|
|
|||
| ### private create | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'private create' should use sentence-style capitalization.
| @@ -129,6 +127,7 @@ Use the following options to change the behavior of this command. You can also u | |||
| ### endpoint delete | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'endpoint delete' should use sentence-style capitalization.
| | `--api-key` | No | **string** API key for authenticating with Temporal Cloud. Can be used instead of interactive login for automation and CI/CD pipelines. | | ||
| | `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | ||
|
|
||
| ## Global Flags |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Global Flags' should use sentence-style capitalization.
| | `--namespace`, `-n` | Yes | **string** The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account'). | | ||
| | `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | ||
|
|
||
| ### fairness set |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'fairness set' should use sentence-style capitalization.
| | `--resource-version`, `-v` | No | **string** Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically. | | ||
| | `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | ||
|
|
||
| ## get |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'get' should use sentence-style capitalization.
| @@ -947,13 +909,16 @@ Use the following options to change the behavior of this command. You can also u | |||
| ### ha update | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'ha update' should use sentence-style capitalization.
| | `--page-token` | No | **string** Token for retrieving the next page of results in a paginated list. | | ||
| | `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | ||
|
|
||
| ## mtls |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'mtls' should use sentence-style capitalization.
|
|
||
| Commands for managing mTLS authentication configuration of Temporal Cloud namespaces. | ||
|
|
||
| ### mtls cert-ca |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'mtls cert-ca' should use sentence-style capitalization.
📖 Docs PR preview links
|
|
|
||
| Commands for managing the client CA certificates of Temporal Cloud namespaces. | ||
|
|
||
| #### mtls cert-ca create |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'mtls cert-ca create' should use sentence-style capitalization.
| | `--resource-version`, `-v` | No | **string** Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically. | | ||
| | `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | ||
|
|
||
| #### mtls cert-ca delete |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'mtls cert-ca delete' should use sentence-style capitalization.
| | `--resource-version`, `-v` | No | **string** Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically. | | ||
| | `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | ||
|
|
||
| #### mtls cert-ca list |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'mtls cert-ca list' should use sentence-style capitalization.
| | `--namespace`, `-n` | Yes | **string** The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account'). | | ||
| | `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | ||
|
|
||
| ### mtls cert-filter |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'mtls cert-filter' should use sentence-style capitalization.
| Certificate filters restrict mTLS connections to client certificates with | ||
| specific distinguished name properties. | ||
|
|
||
| #### mtls cert-filter create |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'mtls cert-filter create' should use sentence-style capitalization.
| | `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | ||
| | `--subject-alternative-name` | No | **string** The subject alternative name (SAN) from the certificate. | | ||
|
|
||
| #### mtls cert-filter list |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'mtls cert-filter list' should use sentence-style capitalization.
| | `--namespace`, `-n` | Yes | **string** The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account'). | | ||
| | `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | ||
|
|
||
| ### mtls disable |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'mtls disable' should use sentence-style capitalization.
| | `--resource-version`, `-v` | No | **string** Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically. | | ||
| | `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | ||
|
|
||
| ### mtls enable |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'mtls enable' should use sentence-style capitalization.
| | `--resource-version`, `-v` | No | **string** Resource version for optimistic concurrency control. If not provided, the current version is fetched automatically. | | ||
| | `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | ||
|
|
||
| ### mtls get |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'mtls get' should use sentence-style capitalization.
| | `--namespace`, `-n` | Yes | **string** The fully qualified namespace name in the format 'namespace.account' (e.g., 'my-namespace.my-account'). | | ||
| | `--server` | No | **string** Override the Temporal Cloud API server address. Used for connecting to non-production environments. | | ||
|
|
||
| ## retention |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'retention' should use sentence-style capitalization.
Autogenerated PR from https://github.com/temporalio/cli
┆Attachments: EDU-6695 Update CLI docs for release v1.8.0