From 860bd462faba25cabfa295ba277105e59ba1fb8d Mon Sep 17 00:00:00 2001 From: Will Charczuk Date: Wed, 27 Aug 2025 09:46:56 -0700 Subject: [PATCH 01/10] adds a --grpc-authority flag --- temporalcli/client.go | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/temporalcli/client.go b/temporalcli/client.go index b77c322f1..ff4b03087 100644 --- a/temporalcli/client.go +++ b/temporalcli/client.go @@ -82,9 +82,10 @@ func (c *ClientOptions) dialClient(cctx *CommandContext) (client.Client, error) // Override some values in client config profile that come from CLI args. Some // flags, like address and namespace, have CLI defaults, but we don't want to // override the profile version unless it was _explicitly_ set. - var addressExplicitlySet, namespaceExplicitlySet bool + var addressExplicitlySet, grpcAuthorityExplicitlySet, namespaceExplicitlySet bool if cctx.CurrentCommand != nil { addressExplicitlySet = cctx.CurrentCommand.Flags().Changed("address") + grpcAuthorityExplicitlySet = cctx.CurrentCommand.Flags().Changed("grpc-authority") namespaceExplicitlySet = cctx.CurrentCommand.Flags().Changed("namespace") } if addressExplicitlySet { @@ -172,6 +173,11 @@ func (c *ClientOptions) dialClient(cctx *CommandContext) (client.Client, error) if err != nil { return nil, fmt.Errorf("failed creating client options: %w", err) } + + if grpcAuthorityExplicitlySet { + clientOptions.ConnectionOptions.Authority = c.GrpcAuthority + } + clientOptions.Logger = log.NewStructuredLogger(cctx.Logger) clientOptions.Identity = clientIdentity() // We do not put codec on data converter here, it is applied via From a9d97c5487c2f839e4892ec7abbfd84b6bbdb1e7 Mon Sep 17 00:00:00 2001 From: Will Charczuk Date: Wed, 27 Aug 2025 10:39:57 -0700 Subject: [PATCH 02/10] adds more options etc. --- go.mod | 6 +- go.sum | 66 +- temporalcli/commands.config.go | 1 + temporalcli/commands.gen.go | 2 + temporalcli/commandsgen/commands.yml | 4 + temporalcli/docs/activity.mdx | 1274 +++++++ temporalcli/docs/batch.mdx | 519 +++ temporalcli/docs/config.mdx | 836 +++++ temporalcli/docs/env.mdx | 701 ++++ temporalcli/docs/operator.mdx | 3434 +++++++++++++++++ temporalcli/docs/schedule.mdx | 1693 +++++++++ temporalcli/docs/server.mdx | 273 ++ temporalcli/docs/task-queue.mdx | 3026 +++++++++++++++ temporalcli/docs/worker.mdx | 1581 ++++++++ temporalcli/docs/workflow.mdx | 5172 ++++++++++++++++++++++++++ 15 files changed, 18525 insertions(+), 63 deletions(-) create mode 100644 temporalcli/docs/activity.mdx create mode 100644 temporalcli/docs/batch.mdx create mode 100644 temporalcli/docs/config.mdx create mode 100644 temporalcli/docs/env.mdx create mode 100644 temporalcli/docs/operator.mdx create mode 100644 temporalcli/docs/schedule.mdx create mode 100644 temporalcli/docs/server.mdx create mode 100644 temporalcli/docs/task-queue.mdx create mode 100644 temporalcli/docs/worker.mdx create mode 100644 temporalcli/docs/workflow.mdx diff --git a/go.mod b/go.mod index f7d1f9238..4d21c6701 100644 --- a/go.mod +++ b/go.mod @@ -16,7 +16,7 @@ require ( github.com/spf13/pflag v1.0.6 github.com/stretchr/testify v1.10.0 github.com/temporalio/ui-server/v2 v2.39.0 - go.temporal.io/api v1.50.0 + go.temporal.io/api v1.51.0 go.temporal.io/sdk v1.35.0 go.temporal.io/sdk/contrib/envconfig v0.1.0 go.temporal.io/server v1.28.0 @@ -27,7 +27,7 @@ require ( ) require ( - cel.dev/expr v0.22.1 // indirect + cel.dev/expr v0.23.1 // indirect cloud.google.com/go v0.120.0 // indirect cloud.google.com/go/auth v0.15.0 // indirect cloud.google.com/go/auth/oauth2adapt v0.2.8 // indirect @@ -76,7 +76,7 @@ require ( github.com/googleapis/gax-go/v2 v2.14.1 // indirect github.com/gorilla/mux v1.8.1 // indirect github.com/gorilla/securecookie v1.1.2 // indirect - github.com/grpc-ecosystem/go-grpc-middleware v1.4.0 // indirect + github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.2 // indirect github.com/grpc-ecosystem/grpc-gateway/v2 v2.26.3 // indirect github.com/hailocab/go-hostpool v0.0.0-20160125115350-e80d13ce29ed // indirect github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect diff --git a/go.sum b/go.sum index a18e8152e..dd6225bee 100644 --- a/go.sum +++ b/go.sum @@ -1,6 +1,5 @@ -cel.dev/expr v0.22.1 h1:xoFEsNh972Yzey8N9TCPx2nDvMN7TMhQEzxLuj/iRrI= -cel.dev/expr v0.22.1/go.mod h1:MrpN08Q+lEBs+bGYdLxxHkZoUSsCp0nSKTs0nTymJgw= -cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= +cel.dev/expr v0.23.1 h1:K4KOtPCJQjVggkARsjG9RWXP6O4R73aHeJMa/dmCQQg= +cel.dev/expr v0.23.1/go.mod h1:hLPLo1W4QUmuYdA72RBX06QTs6MXw941piREPl3Yfiw= cloud.google.com/go v0.120.0 h1:wc6bgG9DHyKqF5/vQvX1CiZrtHnxJjBlKUyF9nP6meA= cloud.google.com/go v0.120.0/go.mod h1:/beW32s8/pGRuj4IILWQNd4uuebeT4dkOhKmkfit64Q= cloud.google.com/go/auth v0.15.0 h1:Ly0u4aA5vG/fsSsxu98qCQBemXtAtJf+95z9HK+cxps= @@ -54,7 +53,6 @@ github.com/apache/thrift v0.21.0/go.mod h1:W1H8aR/QRtYNvrPeFXBtobyRkd0/YVhTc6i07 github.com/aws/aws-sdk-go v1.55.6 h1:cSg4pvZ3m8dgYcgqB97MrcdjUmZ1BeMYKUxMMB89IPk= github.com/aws/aws-sdk-go v1.55.6/go.mod h1:eRwEWoyTWFMVYVQzKMNHWP5/RV4xIUGMQfXQHfHkpNU= github.com/benbjohnson/clock v0.0.0-20160125162948-a620c1cc9866/go.mod h1:UMqtWQTnOe4byzwe7Zhwh8f8s+36uszN51sJrSIZlTE= -github.com/benbjohnson/clock v1.1.0/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA= github.com/benbjohnson/clock v1.3.5 h1:VvXlSJBzZpA/zum6Sj74hxwYI2DIxRWuNIoXAzHZz5o= github.com/benbjohnson/clock v1.3.5/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA= github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= @@ -75,11 +73,8 @@ github.com/cactus/go-statsd-client/v5 v5.1.0 h1:sbbdfIl9PgisjEoXzvXI1lwUKWElngsj github.com/cactus/go-statsd-client/v5 v5.1.0/go.mod h1:COEvJ1E+/E2L4q6QE5CkjWPi4eeDw9maJBMIuMPBZbY= github.com/cenkalti/backoff/v4 v4.3.0 h1:MyRJ/UdXutAwSAT+s3wNd7MfTIcy71VQueUuFK343L8= github.com/cenkalti/backoff/v4 v4.3.0/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE= -github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs= github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= -github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= -github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc= github.com/cncf/xds/go v0.0.0-20250326154945-ae57f3c0d45f h1:C5bqEmzEPLsHm9Mv73lSE9e9bKV23aB1vxOsmZrkl3k= github.com/cncf/xds/go v0.0.0-20250326154945-ae57f3c0d45f/go.mod h1:W+zGtBO5Y1IgJhy4+A9GOqVhqLpfZi+vwmdNXUehLA8= github.com/coreos/go-oidc/v3 v3.13.0 h1:M66zd0pcc5VxvBNM4pB331Wrsanby+QomQYjN8HamW8= @@ -98,16 +93,12 @@ github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkp github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto= github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= -github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= -github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= -github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98= github.com/envoyproxy/go-control-plane v0.13.4 h1:zEqyPVyku6IvWCFwux4x9RxkLOMUL+1vC9xUFv5l2/M= github.com/envoyproxy/go-control-plane v0.13.4/go.mod h1:kDfuBlDVsSj2MjrLEtRWtHlsWIFcGyB2RMO44Dc5GZA= github.com/envoyproxy/go-control-plane/envoy v1.32.4 h1:jb83lalDRZSpPWW2Z7Mck/8kXZ5CQAFYVjQcdVIr83A= github.com/envoyproxy/go-control-plane/envoy v1.32.4/go.mod h1:Gzjc5k8JcJswLjAx1Zm+wSYE20UrLtt7JZMWiWQXQEw= github.com/envoyproxy/go-control-plane/ratelimit v0.1.0 h1:/G9QYbddjL25KvtKTv3an9lx6VBE2cnb8wp1vEGNYGI= github.com/envoyproxy/go-control-plane/ratelimit v0.1.0/go.mod h1:Wk+tMFAFbCXaJPzVVHnPgRKdUdwW/KdbRt94AzgRee4= -github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= github.com/envoyproxy/protoc-gen-validate v1.2.1 h1:DEo3O99U8j4hBFwbJfrz9VtgcDfUKS7KJ7spH3d86P8= github.com/envoyproxy/protoc-gen-validate v1.2.1/go.mod h1:d/C80l/jxXLdfEIhX1W2TmLfsJ31lvEjwamM4DxlWXU= github.com/facebookgo/clock v0.0.0-20150410010913-600d898af40a h1:yDWHCSQ40h88yih2JAcL6Ls/kVkSE8GFACTGVnMPruw= @@ -126,8 +117,6 @@ github.com/go-faker/faker/v4 v4.6.0/go.mod h1:ZmrHuVtTTm2Em9e0Du6CJ9CADaLEzGXW62 github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU= github.com/go-jose/go-jose/v4 v4.0.5 h1:M6T8+mKZl/+fNNuFHvGIzDz7BTLQPIounk/b9dw3AaE= github.com/go-jose/go-jose/v4 v4.0.5/go.mod h1:s3P1lRrkT8igV8D9OjyL4WRyHvjB6a4JSllnOrmmBOA= -github.com/go-kit/log v0.1.0/go.mod h1:zbhenjAZHb184qTLMA9ZjW7ThYL0H2mk7Q6pNt4vbaY= -github.com/go-logfmt/logfmt v0.5.0/go.mod h1:wCYkCAKZfumFQihp8CzCvQ3paCTfi41vtzG1KdI/P7A= github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY= github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= @@ -136,7 +125,6 @@ github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre github.com/go-sql-driver/mysql v1.8.1/go.mod h1:wEBSXgmK//2ZFJyE+qWnIsVGmvmEKlqwuVSjsCm7DZg= github.com/go-sql-driver/mysql v1.9.1 h1:FrjNGn/BsJQjVRuSa8CBrM5BWA9BWoXXat3KrtSb/iI= github.com/go-sql-driver/mysql v1.9.1/go.mod h1:qn46aNg1333BRMNU69Lq93t8du/dwxI64Gl8i5p1WMU= -github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= github.com/gocql/gocql v1.7.0 h1:O+7U7/1gSN7QTEAaMEsJc1Oq2QHXvCWoF3DFK9HDHus= github.com/gocql/gocql v1.7.0/go.mod h1:vnlvXyFZeLBF0Wy+RS8hrOdbn0UWsWtdg07XJnFxZ+4= github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= @@ -144,14 +132,9 @@ github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69 github.com/golang-jwt/jwt/v4 v4.5.2 h1:YtQM7lnr8iZ+j5q71MGKkNw9Mn7AjHM68uc9g5fXeUI= github.com/golang-jwt/jwt/v4 v4.5.2/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0/go.mod h1:E/TSTwGwJL78qG/PmXZO1EjYhfJinVAhrmmHX6Z8B9k= -github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= -github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= github.com/golang/mock v1.5.0/go.mod h1:CWnOUgYIOo4TcNZ0wHX3YZCqsaM1I1Jvs6v3mP3KVu8= github.com/golang/mock v1.7.0-rc.1 h1:YojYx61/OLFsiv6Rw1Z96LpldJIy31o+UHmwAUMJ6/U= github.com/golang/mock v1.7.0-rc.1/go.mod h1:s42URUywIqd+OcERslBJvOjepvNymP31m3q8d/GkuRs= -github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= -github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= -github.com/golang/protobuf v1.3.3/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw= github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek= github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps= github.com/golang/snappy v0.0.3/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= @@ -159,7 +142,6 @@ github.com/golang/snappy v1.0.0 h1:Oy607GVXHs7RtbggtPBnr2RmDArIsAefDwvrdWvRhGs= github.com/golang/snappy v1.0.0/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= github.com/gomarkdown/markdown v0.0.0-20250311123330-531bef5e742b h1:EY/KpStFl60qA17CptGXhwfZ+k1sFNJIUNR8DdbcuUk= github.com/gomarkdown/markdown v0.0.0-20250311123330-531bef5e742b/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA= -github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= @@ -183,8 +165,8 @@ github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY= github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ= github.com/gorilla/securecookie v1.1.2 h1:YCIWL56dvtr73r6715mJs5ZvhtnY73hBvEF8kXD8ePA= github.com/gorilla/securecookie v1.1.2/go.mod h1:NfCASbcHqRSY+3a8tlWJwsQap2VX5pwzwo4h3eOamfo= -github.com/grpc-ecosystem/go-grpc-middleware v1.4.0 h1:UH//fgunKIs4JdUbpDl1VZCDaL56wXCB/5+wF6uHfaI= -github.com/grpc-ecosystem/go-grpc-middleware v1.4.0/go.mod h1:g5qyo/la0ALbONm6Vbp88Yd8NsDy6rZz+RcrMPxvld8= +github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.2 h1:sGm2vDRFUrQJO/Veii4h4zG2vvqG6uWNkBHSTqXOZk0= +github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.2/go.mod h1:wd1YpapPLivG6nQgbf7ZkG1hhSOXDhhn4MLTknx2aAc= github.com/grpc-ecosystem/grpc-gateway/v2 v2.26.3 h1:5ZPtiqj0JL5oKWmcsq4VMaAW5ukBEgSGXEN89zeH1Jo= github.com/grpc-ecosystem/grpc-gateway/v2 v2.26.3/go.mod h1:ndYquD05frm2vACXE1nsccT4oJzjhw2arTS2cpUD1PI= github.com/hailocab/go-hostpool v0.0.0-20160125115350-e80d13ce29ed h1:5upAirOpQc1Q53c0bnx2ufif5kANL7bfZWcc6VJWJd8= @@ -282,7 +264,6 @@ github.com/prashantv/protectmem v0.0.0-20171002184600-e20412882b3a h1:AA9vgIBDjM github.com/prashantv/protectmem v0.0.0-20171002184600-e20412882b3a/go.mod h1:lzZQ3Noex5pfAy7mkAeCjcBDteYU85uWWnJ/y6gKU8k= github.com/prometheus/client_golang v1.21.1 h1:DOvXXTqVzvkIewV/CDPFdejpMCGeMcbGCQ8YOmu+Ibk= github.com/prometheus/client_golang v1.21.1/go.mod h1:U9NM32ykUErtVBxdvD3zfi+EuFkkaBvMb09mIfe0Zgg= -github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= github.com/prometheus/client_model v0.6.1 h1:ZKSh/rekM+n3CeS952MLRAdFwIKqeY8b62p8ais2e9E= github.com/prometheus/client_model v0.6.1/go.mod h1:OrxVMOVHjw3lKMa8+x6HeMGkHMQyHDk9E3jmP2AmGiY= github.com/prometheus/common v0.63.0 h1:YR/EIY1o3mEFP/kZCD7iDMnLPlGyuU2Gb3HIcXnA98k= @@ -390,12 +371,8 @@ go.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt go.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc= go.opentelemetry.io/proto/otlp v1.5.0 h1:xJvq7gMzB31/d406fB8U5CBdyQGw4P399D1aQWU/3i4= go.opentelemetry.io/proto/otlp v1.5.0/go.mod h1:keN8WnHxOy8PG0rQZjJJ5A2ebUoafqWp0eVQ4yIXvJ4= -go.temporal.io/api v1.50.0 h1:7s8Cn+fKfNx9G0v2Ge9We6X2WiCA3JvJ9JryeNbx1Bc= -go.temporal.io/api v1.50.0/go.mod h1:iaxoP/9OXMJcQkETTECfwYq4cw/bj4nwov8b3ZLVnXM= -go.temporal.io/sdk v1.35.0 h1:lRNAQ5As9rLgYa7HBvnmKyzxLcdElTuoFJ0FXM/AsLQ= -go.temporal.io/sdk v1.35.0/go.mod h1:1q5MuLc2MEJ4lneZTHJzpVebW2oZnyxoIOWX3oFVebw= -go.temporal.io/sdk/contrib/envconfig v0.1.0 h1:s+G/Ujph+Xl2jzLiiIm2T1vuijDkUL4Kse49dgDVGBE= -go.temporal.io/sdk/contrib/envconfig v0.1.0/go.mod h1:FQEO3C56h9C7M6sDgSanB8HnBTmopw9qgVx4F1S6pJk= +go.temporal.io/api v1.51.0 h1:9+e14GrIa7nWoWoudqj/PSwm33yYjV+u8TAR9If7s/g= +go.temporal.io/api v1.51.0/go.mod h1:iaxoP/9OXMJcQkETTECfwYq4cw/bj4nwov8b3ZLVnXM= go.temporal.io/server v1.28.0 h1:1rLPrT21ZwpsRjElJqSgThj1NZSAtAPyi8nKX+EAkgo= go.temporal.io/server v1.28.0/go.mod h1:yri8PdZoAtwI9p65hzvABf11WqXelHl/HabbrnJSu+g= go.temporal.io/version v0.3.0 h1:dMrei9l9NyHt8nG6EB8vAwDLLTwx2SvRyucCSumAiig= @@ -408,19 +385,16 @@ go.uber.org/dig v1.18.1 h1:rLww6NuajVjeQn+49u5NcezUJEGwd5uXmyoCKW2g5Es= go.uber.org/dig v1.18.1/go.mod h1:Us0rSJiThwCv2GteUN0Q7OKvU7n5J4dxZ9JKUXozFdE= go.uber.org/fx v1.23.0 h1:lIr/gYWQGfTwGcSXWXu4vP5Ws6iqnNEIY+F/aFzCKTg= go.uber.org/fx v1.23.0/go.mod h1:o/D9n+2mLP6v1EG+qsdT1O8wKopYAsqZasju97SDFCU= -go.uber.org/goleak v1.1.10/go.mod h1:8a7PlsEVH3e/a/GLqe5IIrQx6GzcnRmZEufDUTk4A7A= go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= go.uber.org/mock v0.5.0 h1:KAMbZvZPyBPWgD14IrIQ38QCyjwpvVVV6K/bHl1IwQU= go.uber.org/mock v0.5.0/go.mod h1:ge71pBPLYDk7QIi1LupWxdAykm7KIEFchiOqd6z7qMM= go.uber.org/multierr v1.3.0/go.mod h1:VgVr7evmIr6uPjLBxg28wmKNXyqE9akIJ5XnfpiKl+4= -go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU= go.uber.org/multierr v1.7.0/go.mod h1:7EAYxJLBy9rStEaz58O2t4Uvip6FSURkq8/ppBp95ak= go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee/go.mod h1:vJERXedbb3MVM5f9Ejo0C68/HhF8uaILCdgjnY+goOA= go.uber.org/zap v1.14.0/go.mod h1:zwrFLgMcdUuIBviXEYEH1YKNaOBnKXsx2IPda5bBwHM= -go.uber.org/zap v1.18.1/go.mod h1:xg/QME4nWcxGxrpdeYfq7UvYrLh66cuVKdrbD1XF/NI= go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8= go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= @@ -433,7 +407,6 @@ golang.org/x/crypto v0.38.0 h1:jt+WWG8IZlBnVbomuhg2Mdq0+BBQaHbtqHEFEigjUV8= golang.org/x/crypto v0.38.0/go.mod h1:MvrbAqul58NNYPKnOra203SB9vpuZW0e+RRZV+Ggqjw= golang.org/x/exp v0.0.0-20180321215751-8460e604b9de/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20180807140117-3d87b88a115f/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= -golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190125153040-c74c464bbbf2/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20191030013958-a1ab85dbe136/go.mod h1:JXzH8nQsPlswgeRAPE3MuO9GYsAcnJvJ4vnMwN/5qkY= @@ -442,9 +415,6 @@ golang.org/x/exp v0.0.0-20250305212735-054e65f0b394/go.mod h1:sIifuuw/Yco/y6yb6+ golang.org/x/image v0.0.0-20180708004352-c73c2afc3b81/go.mod h1:ux5Hcp/YLpHSI86hEcLt0YII63i6oz57MZXIpbrjZUs= golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js= golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= -golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= -golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= -golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= golang.org/x/mobile v0.0.0-20190719004257-d2bd2a29d028/go.mod h1:E/iHnbuqvinMTCcRqshq8CkpyQDoeVncDDYHnLhea+o= golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc= @@ -456,9 +426,6 @@ golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91 golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU= golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww= -golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= -golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= -golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= @@ -472,11 +439,8 @@ golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= golang.org/x/net v0.40.0 h1:79Xs7wF06Gbdcg4kdCCIQArK11Z1hr5POQ6+fIYHNuY= golang.org/x/net v0.40.0/go.mod h1:y0hY0exeL2Pku80/zKK7tpntoX23cqL3Oa6njdgRtds= -golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.30.0 h1:dnDm7JmhM45NNpd8FDDeLhK6FwqbOf4MLCM9zb1BOHI= golang.org/x/oauth2 v0.30.0/go.mod h1:B++QgG3ZKulg6sRPGD/mqlHQs5rB3Ml9erfeDY7xKlU= -golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -485,7 +449,6 @@ golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJ golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.14.0 h1:woo0S4Yywslg6hp4eUFjTVOyKt0RookbpAHG4c1HmhQ= golang.org/x/sync v0.14.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= -golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -497,7 +460,6 @@ golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20211019181941-9d821ace8654/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20211025201205-69cdffdb9359/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= @@ -525,16 +487,12 @@ golang.org/x/time v0.11.0 h1:/bpjEDfN9tkoN/ryeYHnv5hcMlc8ncjMcM4XBk5NWV0= golang.org/x/time v0.11.0/go.mod h1:CDIdPxbZBQxdj6cxyCIdrNogrJKMJ7pr37NYpMcMDSg= golang.org/x/tools v0.0.0-20180525024113-a5b4c53f6e8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190206041539-40960b6deb8e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY= golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= -golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20191012152004-8de300cfc20a/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= -golang.org/x/tools v0.0.0-20191108193012-7d206e10da11/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= @@ -553,22 +511,12 @@ gonum.org/v1/netlib v0.0.0-20190313105609-8cb42192e0e0/go.mod h1:wa6Ws7BG/ESfp6d gonum.org/v1/plot v0.0.0-20190515093506-e2840ee46a6b/go.mod h1:Wt8AAjI+ypCyYX3nZBvf6cAIx93T+c/OS2HFAYskSZc= google.golang.org/api v0.228.0 h1:X2DJ/uoWGnY5obVjewbp8icSL5U4FzuCfy9OjbLSnLs= google.golang.org/api v0.228.0/go.mod h1:wNvRS1Pbe8r4+IfBIniV8fwCpGwTrYa+kMUDiC5z5a4= -google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= -google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= -google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc= -google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc= -google.golang.org/genproto v0.0.0-20200423170343-7949de9c1215/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/genproto v0.0.0-20250324211829-b45e905df463 h1:qEFnJI6AnfZk0NNe8YTyXQh5i//Zxi4gBHwRgp76qpw= google.golang.org/genproto v0.0.0-20250324211829-b45e905df463/go.mod h1:SqIx1NV9hcvqdLHo7uNZDS5lrUJybQ3evo3+z/WBfA0= google.golang.org/genproto/googleapis/api v0.0.0-20250324211829-b45e905df463 h1:hE3bRWtU6uceqlh4fhrSnUyjKHMKB9KrTLLG+bc0ddM= google.golang.org/genproto/googleapis/api v0.0.0-20250324211829-b45e905df463/go.mod h1:U90ffi8eUL9MwPcrJylN5+Mk2v3vuPDptd5yyNUiRR8= google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463 h1:e0AIkUUhxyBKh6ssZNrAMeqhA7RKUj42346d1y02i2g= google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A= -google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= -google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg= -google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY= -google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk= -google.golang.org/grpc v1.29.1/go.mod h1:itym6AZVZYACWQqET3MqgPpjcuV5QH3BxFS3IjizoKk= google.golang.org/grpc v1.71.0 h1:kF77BGdPTQ4/JZWMlb9VpJ5pa25aqvVqogsxNHHdeBg= google.golang.org/grpc v1.71.0/go.mod h1:H0GRtasmQOh9LkFoCPDu3ZrwUtD1YGE+b2vYBYd/8Ec= google.golang.org/protobuf v1.36.6 h1:z1NpPI8ku2WgiWnf+t9wTPsn6eP1L7ksHUlkfLvd9xY= @@ -591,8 +539,6 @@ gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= -honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= -honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg= modernc.org/cc/v4 v4.25.2 h1:T2oH7sZdGvTaie0BRNFbIYsabzCxUQg8nLqCdQ2i0ic= modernc.org/cc/v4 v4.25.2/go.mod h1:uVtb5OGqUKpoLWhqwNQo/8LwvoiEBLvZXIQ/SmO6mL0= diff --git a/temporalcli/commands.config.go b/temporalcli/commands.config.go index a4028ff46..7319dd218 100644 --- a/temporalcli/commands.config.go +++ b/temporalcli/commands.config.go @@ -251,6 +251,7 @@ func loadEnvConfigProfile( var envConfigPropsToFieldNames = map[string]string{ "address": "Address", + "grpc_authority": "GRPCAuthority", "namespace": "Namespace", "api_key": "APIKey", "tls": "TLS", diff --git a/temporalcli/commands.gen.go b/temporalcli/commands.gen.go index a27289bd7..90e36339a 100644 --- a/temporalcli/commands.gen.go +++ b/temporalcli/commands.gen.go @@ -18,6 +18,7 @@ var hasHighlighting = isatty.IsTerminal(os.Stdout.Fd()) type ClientOptions struct { Address string + GrpcAuthority string Namespace string ApiKey string GrpcMeta []string @@ -37,6 +38,7 @@ type ClientOptions struct { func (v *ClientOptions) buildFlags(cctx *CommandContext, f *pflag.FlagSet) { f.StringVar(&v.Address, "address", "127.0.0.1:7233", "Temporal Service gRPC endpoint.") + f.StringVar(&v.GrpcAuthority, "grpc-authority", "", "Temporal gRPC client :authority pseudoheader.") f.StringVarP(&v.Namespace, "namespace", "n", "default", "Temporal Service Namespace.") f.StringVar(&v.ApiKey, "api-key", "", "API key for request.") f.StringArrayVar(&v.GrpcMeta, "grpc-meta", nil, "HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`.") diff --git a/temporalcli/commandsgen/commands.yml b/temporalcli/commandsgen/commands.yml index 8542f6184..23b942aa7 100644 --- a/temporalcli/commandsgen/commands.yml +++ b/temporalcli/commandsgen/commands.yml @@ -4051,6 +4051,10 @@ option-sets: description: Temporal Service gRPC endpoint. default: 127.0.0.1:7233 implied-env: TEMPORAL_ADDRESS + - name: grpc-authority + type: string + description: Temporal gRPC client :authority pseudoheader. + implied-env: TEMPORAL_GRPC_AUTHORITY - name: namespace short: n type: string diff --git a/temporalcli/docs/activity.mdx b/temporalcli/docs/activity.mdx new file mode 100644 index 000000000..6254e9b88 --- /dev/null +++ b/temporalcli/docs/activity.mdx @@ -0,0 +1,1274 @@ +{/* 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 */} +--- +id: activity +title: Temporal CLI activity command reference +sidebar_label: activity +description: Learn how to use Temporal Activity commands for completing or failing Activity Executions in your Workflow. Optimize your Temporal Workflow management effectively. +toc_max_heading_level: 4 +keywords: + - activity + - activity complete + - activity update-options + - activity pause + - activity unpause + - activity reset + - activity execution + - activity fail + - cli reference + - cli-feature + - command-line-interface-cli + - temporal cli +tags: + - Activities + - Temporal CLI +--- + +## complete + +Complete an Activity, marking it as successfully finished. Specify the +Activity ID and include a JSON result for the returned value: + +``` +temporal activity complete \ + --activity-id YourActivityId \ + --workflow-id YourWorkflowId \ + --result '{"YourResultKey": "YourResultVal"}' +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--activity-id** _string_ + +Activity ID to complete. Required. + +**--identity** _string_ + +Identity of the user submitting this request. + +**--result** _string_ + +Result `JSON` to return. Required. + +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## fail + +Fail an Activity, marking it as having encountered an error. Specify the +Activity and Workflow IDs: + +``` +temporal activity fail \ + --activity-id YourActivityId \ + --workflow-id YourWorkflowId +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--activity-id** _string_ + +Activity ID to fail. Required. + +**--detail** _string_ + +Reason for failing the Activity (JSON). + +**--identity** _string_ + +Identity of the user submitting this request. + +**--reason** _string_ + +Reason for failing the Activity. + +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## pause + +Pause an Activity. + +If the Activity is not currently running (e.g. because it previously +failed), it will not be run again until it is unpaused. + +However, if the Activity is currently running, it will run until the next +time it fails, completes, or times out, at which point the pause will kick in. + +If the Activity is on its last retry attempt and fails, the failure will +be returned to the caller, just as if the Activity had not been paused. + +Activities should be specified either by their Activity ID or Activity Type. + +For example, specify the Activity and Workflow IDs like this: + +``` +temporal activity pause \ + --activity-id YourActivityId \ + --workflow-id YourWorkflowId +``` + +To later unpause the activity, see [unpause](#unpause). You may also want to +[reset](#reset) the activity to unpause it while also starting it from the beginning. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--activity-id**, **-a** _string_ + +The Activity ID to pause. Either `activity-id` or `activity-type` must be provided, but not both. + +**--activity-type**, **-g** _string_ + +All activities of the Activity Type will be paused. Either `activity-id` or `activity-type` must be provided, but not both. + +**--identity** _string_ + +The identity of the user or client submitting this request. + +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## reset + +Reset an activity. This restarts the activity as if it were first being +scheduled. That is, it will reset both the number of attempts and the +activity timeout, as well as, optionally, the +[heartbeat details](#reset-heartbeats). + +If the activity may be executing (i.e. it has not yet timed out), the +reset will take effect the next time it fails, heartbeats, or times out. +If is waiting for a retry (i.e. has failed or timed out), the reset +will apply immediately. + +If the activity is already paused, it will be unpaused by default. +You can specify `keep_paused` to prevent this. + +If the activity is paused and the `keep_paused` flag is not provided, +it will be unpaused. If the activity is paused and `keep_paused` flag +is provided - it will stay paused. + +Activities can be specified by their Activity ID or Activity Type. + +### Resetting activities that heartbeat {#reset-heartbeats} + +Activities that heartbeat will receive a [Canceled failure](/references/failures#cancelled-failure) +the next time they heartbeat after a reset. + +If, in your Activity, you need to do any cleanup when an Activity is +reset, handle this error and then re-throw it when you've cleaned up. + +If the `reset_heartbeats` flag is set, the heartbeat details will also be cleared. + +Specify the Activity Type of ID and Workflow IDs: + +``` +temporal activity reset \ + --activity-id YourActivityId \ + --workflow-id YourWorkflowId + --keep-paused + --reset-heartbeats +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--activity-id**, **-a** _string_ + +The Activity ID to reset. Either `activity-id` or `activity-type` must be provided, but not both. + +**--activity-type**, **-g** _string_ + +The Activity Type to reset. Either `activity-id` or `activity-type` must be provided, but not both. + +**--identity** _string_ + +The identity of the user or client submitting this request. + +**--keep-paused** _bool_ + +If the activity was paused, it will stay paused. + +**--reset-heartbeats** _bool_ + +Clear the Activity's heartbeat details. + +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## unpause + +Re-schedule a previously-paused Activity for execution. + +If the Activity is not running and is past its retry timeout, it will be +scheduled immediately. Otherwise, it will be scheduled after its retry +timeout expires. + +Use `--reset-attempts` to reset the number of previous run attempts to +zero. For example, if an Activity is near the maximum number of attempts +N specified in its retry policy, `--reset-attempts` will allow the +Activity to be retried another N times after unpausing. + +Use `--reset-heartbeat` to reset the Activity's heartbeats. + +Activities can be specified by their Activity ID or Activity Type. +One of those parameters must be provided. + +Specify the Activity ID or Type and Workflow IDs: + +``` +temporal activity unpause \ + --activity-id YourActivityId \ + --workflow-id YourWorkflowId + --reset-attempts + --reset-heartbeats +``` + +Activities can be unpaused in bulk via a visibility Query list filter. +For example, if you want to unpause activities of type Foo that you +previously paused, do: + +``` +temporal activity unpause \ + --query 'TemporalPauseInfo="property:activityType=Foo"' +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--activity-id**, **-a** _string_ + +The Activity ID to unpause. Can only be used without --query or --match-all. Either `activity-id` or `activity-type` must be provided, but not both. + +**--activity-type**, **-g** _string_ + +Activities of this Type will unpause. Can only be used without --match-all. Either `activity-id` or `activity-type` must be provided, but not both. + +**--identity** _string_ + +The identity of the user or client submitting this request. + +**--jitter**, **-j** _duration_ + +The activity will start at random a time within the specified duration. Can only be used with --query. + +**--match-all** _bool_ + +Every paused activity should be unpaused. This flag is ignored if activity-type is provided. Can only be used with --query. + +**--query**, **-q** _string_ + +Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. + +**--reason** _string_ + +Reason for batch operation. Only use with --query. Defaults to user name. + +**--reset-attempts** _bool_ + +Also reset the activity attempts. + +**--reset-heartbeats** _bool_ + +Reset the Activity's heartbeats. Only works with --reset-attempts. + +**--rps** _float_ + +Limit batch's requests per second. Only allowed if query is present. + +**--run-id**, **-r** _string_ + +Run ID. Only use with --workflow-id. Cannot use with --query. + +**--workflow-id**, **-w** _string_ + +Workflow ID. You must set either --workflow-id or --query. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm signaling. Only allowed when --query is present. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## update-options + +Update the options of a running Activity that were passed into it from + a Workflow. Updates are incremental, only changing the specified + options. + +For example: + +``` +temporal activity update-options \ + --activity-id YourActivityId \ + --workflow-id YourWorkflowId \ + --task-queue NewTaskQueueName \ + --schedule-to-close-timeout DURATION \ + --schedule-to-start-timeout DURATION \ + --start-to-close-timeout DURATION \ + --heartbeat-timeout DURATION \ + --retry-initial-interval DURATION \ + --retry-maximum-interval DURATION \ + --retry-backoff-coefficient NewBackoffCoefficient \ + --retry-maximum-attempts NewMaximumAttempts +``` + +You may follow this command with `temporal activity reset`, and the new values will apply after the reset. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--activity-id** _string_ + +Activity ID. Required. + +**--heartbeat-timeout** _duration_ + +Maximum permitted time between successful worker heartbeats. + +**--identity** _string_ + +Identity of the user submitting this request. + +**--retry-backoff-coefficient** _float_ + +Coefficient used to calculate the next retry interval. The next retry interval is previous interval multiplied by the backoff coefficient. Must be 1 or larger. + +**--retry-initial-interval** _duration_ + +Interval of the first retry. If retryBackoffCoefficient is 1.0 then it is used for all retries. + +**--retry-maximum-attempts** _int_ + +Maximum number of attempts. When exceeded the retries stop even if not expired yet. Setting this value to 1 disables retries. Setting this value to 0 means unlimited attempts(up to the timeouts). + +**--retry-maximum-interval** _duration_ + +Maximum interval between retries. Exponential backoff leads to interval increase. This value is the cap of the increase. + +**--run-id**, **-r** _string_ + +Run ID. + +**--schedule-to-close-timeout** _duration_ + +Indicates how long the caller is willing to wait for an activity completion. Limits how long retries will be attempted. + +**--schedule-to-start-timeout** _duration_ + +Limits time an activity task can stay in a task queue before a worker picks it up. This timeout is always non retryable, as all a retry would achieve is to put it back into the same queue. Defaults to the schedule-to-close timeout or workflow execution timeout if not specified. + +**--start-to-close-timeout** _duration_ + +Maximum time an activity is allowed to execute after being picked up by a worker. This timeout is always retryable. + +**--task-queue** _string_ + +Name of the task queue for the Activity. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + diff --git a/temporalcli/docs/batch.mdx b/temporalcli/docs/batch.mdx new file mode 100644 index 000000000..e615bdaed --- /dev/null +++ b/temporalcli/docs/batch.mdx @@ -0,0 +1,519 @@ +{/* 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 */} +--- +id: batch +title: Temporal CLI batch command reference +sidebar_label: batch +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. +toc_max_heading_level: 4 +keywords: + - batch + - batch describe + - batch list + - batch terminate + - cli reference + - cli-feature + - command-line-interface-cli + - temporal cli +tags: + - Temporal CLI +--- + +## describe + +Show the progress of an ongoing batch job. Pass a valid job ID to display its +information: + +``` +temporal batch describe \ + --job-id YourJobId +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--job-id** _string_ + +Batch job ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## list + +Return a list of batch jobs on the Service or within a single Namespace. For +example, list the batch jobs for "YourNamespace": + +``` +temporal batch list \ + --namespace YourNamespace +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--limit** _int_ + +Maximum number of batch jobs to display. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## terminate + +Terminate a batch job with the provided job ID. You must provide a reason for +the termination. The Service stores this explanation as metadata for the +termination event for later reference: + +``` +temporal batch terminate \ + --job-id YourJobId \ + --reason YourTerminationReason +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--job-id** _string_ + +Job ID to terminate. Required. + +**--reason** _string_ + +Reason for terminating the batch job. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + diff --git a/temporalcli/docs/config.mdx b/temporalcli/docs/config.mdx new file mode 100644 index 000000000..703afeb01 --- /dev/null +++ b/temporalcli/docs/config.mdx @@ -0,0 +1,836 @@ +{/* 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 */} +--- +id: config +title: Temporal CLI config command reference +sidebar_label: config +description: Temporal CLI 'config' commands allow the getting, setting, deleting, and listing of configuration properties for connecting to Temporal. +toc_max_heading_level: 4 +keywords: + - cli reference + - command-line-interface-cli + - configuration + - config + - config delete + - config get + - config list + - config set + - environment + - temporal cli +tags: + - Temporal CLI +--- + +## delete + +Remove a property within a profile. + +``` +temporal env delete \ + --prop tls.client_cert_path +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--prop**, **-p** _string_ + +Specific property to delete. If unset, deletes entire profile. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## delete-profile + +Remove a full profile entirely. The `--profile` must be set explicitly. + +``` +temporal env delete-profile \ + --profile my-profile +``` + +Use the following options to change the behavior of this command. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## get + +Display specific properties or the entire profile. + +``` +temporal config get \ + --prop address +``` + +or + +``` +temporal config get +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--prop**, **-p** _string_ + +Specific property to get. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## list + +List profile names in the config file. + +``` +temporal config list +``` + +Use the following options to change the behavior of this command. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## set + +Assign a value to a property and store it in the config file: + +``` +temporal config set \ + --prop address \ + --value us-west-2.aws.api.temporal.io:7233 +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--prop**, **-p** _string_ + +Property name. Required. + +**--value**, **-v** _string_ + +Property value. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + diff --git a/temporalcli/docs/env.mdx b/temporalcli/docs/env.mdx new file mode 100644 index 000000000..a2adf7cd0 --- /dev/null +++ b/temporalcli/docs/env.mdx @@ -0,0 +1,701 @@ +{/* 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 */} +--- +id: env +title: Temporal CLI env command reference +sidebar_label: env +description: Temporal CLI 'env' commands allow the configuration, setting, deleting, and listing of environmental properties, making it easy to manage Temporal Server instances. +toc_max_heading_level: 4 +keywords: + - cli reference + - command-line-interface-cli + - configuration + - env + - env delete + - env get + - env list + - env set + - environment + - temporal cli +tags: + - Temporal CLI +--- + +## delete + +Remove a presets environment entirely _or_ remove a key-value pair within an +environment. If you don't specify an environment (with `--env` or by setting +the `TEMPORAL_ENV` variable), this command updates the "default" environment: + +``` +temporal env delete \ + --env YourEnvironment +``` + +or + +``` +temporal env delete \ + --env prod \ + --key tls-key-path +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--key**, **-k** _string_ + +Property name. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## get + +List the properties for a given environment: + +``` +temporal env get \ + --env YourEnvironment +``` + +Print a single property: + +``` +temporal env get \ + --env YourEnvironment \ + --key YourPropertyKey +``` + +If you don't specify an environment (with `--env` or by setting the +`TEMPORAL_ENV` variable), this command lists properties of the "default" +environment. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--key**, **-k** _string_ + +Property name. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## list + +List the environments you have set up on your local computer. Environments are +stored in "$HOME/.config/temporalio/temporal.yaml". + +Use the following options to change the behavior of this command. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## set + +Assign a value to a property key and store it to an environment: + +``` +temporal env set \ + --env environment \ + --key property \ + --value value +``` + +If you don't specify an environment (with `--env` or by setting the +`TEMPORAL_ENV` variable), this command sets properties in the "default" +environment. + +Storing keys with CLI option names lets the CLI automatically set those +options for you. This reduces effort and helps avoid typos when issuing +commands. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--key**, **-k** _string_ + +Property name (required). + +**--value**, **-v** _string_ + +Property value (required). + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + diff --git a/temporalcli/docs/operator.mdx b/temporalcli/docs/operator.mdx new file mode 100644 index 000000000..84551d49e --- /dev/null +++ b/temporalcli/docs/operator.mdx @@ -0,0 +1,3434 @@ +{/* 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 */} +--- +id: operator +title: Temporal CLI operator command reference +sidebar_label: operator +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]". +toc_max_heading_level: 4 +keywords: + - cli reference + - cluster + - cluster health + - cluster list + - cluster remove + - cluster upsert + - command-line-interface-cli + - describe + - namespace + - namespace create + - namespace delete + - namespace describe + - namespace list + - nexus + - nexus endpoint + - nexus endpoint create + - nexus endpoint delete + - nexus endpoint get + - nexus endpoint list + - nexus endpoint update + - operator + - search attribute + - search attribute create + - search attribute list + - search attribute remove + - system + - temporal cli + - update +tags: + - Temporal CLI +--- + +## cluster + +Perform operator actions on Temporal Services (also known as Clusters). + +``` +temporal operator cluster [subcommand] [options] +``` + +For example to check Service/Cluster health: + +``` +temporal operator cluster health +``` + +### describe + +View information about a Temporal Cluster (Service), including Cluster Name, +persistence store, and visibility store. Add `--detail` for additional info: + +``` +temporal operator cluster describe [--detail] +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--detail** _bool_ + +Show history shard count and Cluster/Service version information. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### health + +View information about the health of a Temporal Service: + +``` +temporal operator cluster health +``` + +Use the following options to change the behavior of this command. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### list + +Print a list of remote Temporal Clusters (Services) registered to the local +Service. Report details include the Cluster's name, ID, address, History Shard +count, Failover version, and availability: + +``` +temporal operator cluster list [--limit max-count] +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--limit** _int_ + +Maximum number of Clusters to display. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### remove + +Remove a registered remote Temporal Cluster (Service) from the local Service. + +``` +temporal operator cluster remove \ + --name YourClusterName +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--name** _string_ + +Cluster/Service name. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### system + +Show Temporal Server information for Temporal Clusters (Service): Server +version, scheduling support, and more. This information helps diagnose +problems with the Temporal Server. + +The command defaults to the local Service. Otherwise, use the +`--frontend-address` option to specify a Cluster (Service) endpoint: + +``` +temporal operator cluster system \ + --frontend-address "YourRemoteEndpoint:YourRemotePort" +``` + +Use the following options to change the behavior of this command. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### upsert + +Add, remove, or update a registered ("remote") Temporal Cluster (Service). + +``` +temporal operator cluster upsert [options] +``` + +For example: + +``` +temporal operator cluster upsert \ + --frontend-address "YourRemoteEndpoint:YourRemotePort" + --enable-connection false +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--enable-connection** _bool_ + +Set the connection to "enabled". + +**--frontend-address** _string_ + +Remote endpoint. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## namespace + +Manage Temporal Cluster (Service) Namespaces: + +``` +temporal operator namespace [command] [command options] +``` + +For example: + +``` +temporal operator namespace create \ + --namespace YourNewNamespaceName +``` + +### create + +Create a new Namespace on the Temporal Service: + +``` +temporal operator namespace create \ + --namespace YourNewNamespaceName \ + [options] +```` + +Create a Namespace with multi-region data replication: + +``` +temporal operator namespace create \ + --global \ + --namespace YourNewNamespaceName +``` + +Configure settings like retention and Visibility Archival State as needed. +For example, the Visibility Archive can be set on a separate URI: + +``` +temporal operator namespace create \ + --retention 5d \ + --visibility-archival-state enabled \ + --visibility-uri YourURI \ + --namespace YourNewNamespaceName +``` + +Note: URI values for archival states can't be changed once enabled. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--active-cluster** _string_ + +Active Cluster (Service) name. + +**--cluster** _string[]_ + +Cluster (Service) names for Namespace creation. Can be passed multiple times. + +**--data** _string[]_ + +Namespace data as `KEY=VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. + +**--description** _string_ + +Namespace description. + +**--email** _string_ + +Owner email. + +**--global** _bool_ + +Enable multi-region data replication. + +**--history-archival-state** _string-enum_ + +History archival state. Accepted values: disabled, enabled. (default "disabled") + +**--history-uri** _string_ + +Archive history to this `URI`. Once enabled, can't be changed. + +**--retention** _duration_ + +Time to preserve closed Workflows before deletion. (default "72h") + +**--visibility-archival-state** _string-enum_ + +Visibility archival state. Accepted values: disabled, enabled. (default "disabled") + +**--visibility-uri** _string_ + +Archive visibility data to this `URI`. Once enabled, can't be changed. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### delete + +Removes a Namespace from the Service. + +``` +temporal operator namespace delete [options] +``` + +For example: + +``` +temporal operator namespace delete \ + --namespace YourNamespaceName +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--yes**, **-y** _bool_ + +Request confirmation before deletion. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### describe + +Provide long-form information about a Namespace identified by its ID or name: + +``` +temporal operator namespace describe \ + --namespace-id YourNamespaceId +``` + +or + +``` +temporal operator namespace describe \ + --namespace YourNamespaceName +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--namespace-id** _string_ + +Namespace ID. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### list + +Display a detailed listing for all Namespaces on the Service: + +``` +temporal operator namespace list +``` + +Use the following options to change the behavior of this command. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### update + +Update a Namespace using properties you specify. + +``` +temporal operator namespace update [options] +``` + +Assign a Namespace's active Cluster (Service): + +``` +temporal operator namespace update \ + --namespace YourNamespaceName \ + --active-cluster NewActiveCluster +``` + +Promote a Namespace for multi-region data replication: + +``` +temporal operator namespace update \ + --namespace YourNamespaceName \ + --promote-global +``` + +You may update archives that were previously enabled or disabled. Note: URI +values for archival states can't be changed once enabled. + +``` +temporal operator namespace update \ + --namespace YourNamespaceName \ + --history-archival-state enabled \ + --visibility-archival-state disabled +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--active-cluster** _string_ + +Active Cluster (Service) name. + +**--cluster** _string[]_ + +Cluster (Service) names. + +**--data** _string[]_ + +Namespace data as `KEY=VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. + +**--description** _string_ + +Namespace description. + +**--email** _string_ + +Owner email. + +**--history-archival-state** _string-enum_ + +History archival state. Accepted values: disabled, enabled. + +**--history-uri** _string_ + +Archive history to this `URI`. Once enabled, can't be changed. + +**--promote-global** _bool_ + +Enable multi-region data replication. + +**--replication-state** _string-enum_ + +Replication state. Accepted values: normal, handover. + +**--retention** _duration_ + +Length of time a closed Workflow is preserved before deletion. + +**--visibility-archival-state** _string-enum_ + +Visibility archival state. Accepted values: disabled, enabled. + +**--visibility-uri** _string_ + +Archive visibility data to this `URI`. Once enabled, can't be changed. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## nexus + +These commands manage Nexus resources. + +Nexus commands follow this syntax: + +``` +temporal operator nexus [command] [subcommand] [options] +``` + +### endpoint + +These commands manage Nexus Endpoints. + +Nexus Endpoint commands follow this syntax: + +``` +temporal operator nexus endpoint [command] [options] +``` + +#### create + +Create a Nexus Endpoint on the Server. + +A Nexus Endpoint name is used in Workflow code to invoke Nexus Operations. +The endpoint target may either be a Worker, in which case +`--target-namespace` and `--target-task-queue` must both be provided, or +an external URL, in which case `--target-url` must be provided. + +This command will fail if an Endpoint with the same name is already +registered. + +``` +temporal operator nexus endpoint create \ + --name your-endpoint \ + --target-namespace your-namespace \ + --target-task-queue your-task-queue \ + --description-file DESCRIPTION.md +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--description** _string_ + +Nexus Endpoint description. You may use Markdown formatting in the Nexus Endpoint description. + +**--description-file** _string_ + +Path to the Nexus Endpoint description file. The contents of the description file may use Markdown formatting. + +**--name** _string_ + +Endpoint name. Required. + +**--target-namespace** _string_ + +Namespace where a handler Worker polls for Nexus tasks. + +**--target-task-queue** _string_ + +Task Queue that a handler Worker polls for Nexus tasks. + +**--target-url** _string_ + +An external Nexus Endpoint that receives forwarded Nexus requests. May be used as an alternative to `--target-namespace` and `--target-task-queue`. + +:::note + +Option is experimental. + +::: + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +#### delete + +Delete a Nexus Endpoint from the Server. + +``` +temporal operator nexus endpoint delete --name your-endpoint +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--name** _string_ + +Endpoint name. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +#### get + +Get a Nexus Endpoint by name from the Server. + +``` +temporal operator nexus endpoint get --name your-endpoint +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--name** _string_ + +Endpoint name. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +#### list + +List all Nexus Endpoints on the Server. + +``` +temporal operator nexus endpoint list +``` + +Use the following options to change the behavior of this command. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +#### update + +Update an existing Nexus Endpoint on the Server. + +A Nexus Endpoint name is used in Workflow code to invoke Nexus Operations. +The Endpoint target may either be a Worker, in which case +`--target-namespace` and `--target-task-queue` must both be provided, or +an external URL, in which case `--target-url` must be provided. + +The Endpoint is patched; existing fields for which flags are not provided +are left as they were. + +Update only the target task queue: + +``` +temporal operator nexus endpoint update \ + --name your-endpoint \ + --target-task-queue your-other-queue +``` + +Update only the description: + +``` +temporal operator nexus endpoint update \ + --name your-endpoint \ + --description-file DESCRIPTION.md +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--description** _string_ + +Nexus Endpoint description. You may use Markdown formatting in the Nexus Endpoint description. + +**--description-file** _string_ + +Path to the Nexus Endpoint description file. The contents of the description file may use Markdown formatting. + +**--name** _string_ + +Endpoint name. Required. + +**--target-namespace** _string_ + +Namespace where a handler Worker polls for Nexus tasks. + +**--target-task-queue** _string_ + +Task Queue that a handler Worker polls for Nexus tasks. + +**--target-url** _string_ + +An external Nexus Endpoint that receives forwarded Nexus requests. May be used as an alternative to `--target-namespace` and `--target-task-queue`. + +:::note + +Option is experimental. + +::: + +**--unset-description** _bool_ + +Unset the description. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## search-attribute + +Create, list, or remove Search Attributes fields stored in a Workflow +Execution's metadata: + +``` +temporal operator search-attribute create \ + --name YourAttributeName \ + --type Keyword +``` + +Supported types include: Text, Keyword, Int, Double, Bool, Datetime, and +KeywordList. + +If you wish to delete a Search Attribute, please contact support +at https://support.temporal.io. + +### create + +Add one or more custom Search Attributes: + +``` +temporal operator search-attribute create \ + --name YourAttributeName \ + --type Keyword +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--name** _string[]_ + +Search Attribute name. Required. + +**--type** _string-enum[]_ + +Search Attribute type. Required. Accepted values: Text, Keyword, Int, Double, Bool, Datetime, KeywordList. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### list + +Display a list of active Search Attributes that can be assigned or used with +Workflow Queries. You can manage this list and add attributes as needed: + +``` +temporal operator search-attribute list +``` + +Use the following options to change the behavior of this command. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### remove + +Remove custom Search Attributes from the options that can be assigned or used +with Workflow Queries. + +``` +temporal operator search-attribute remove \ + --name YourAttributeName +``` + +Remove attributes without confirmation: + +``` +temporal operator search-attribute remove \ + --name YourAttributeName \ + --yes +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--name** _string[]_ + +Search Attribute name. Required. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm removal. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + diff --git a/temporalcli/docs/schedule.mdx b/temporalcli/docs/schedule.mdx new file mode 100644 index 000000000..d47851a12 --- /dev/null +++ b/temporalcli/docs/schedule.mdx @@ -0,0 +1,1693 @@ +{/* 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 */} +--- +id: schedule +title: Temporal CLI schedule command reference +sidebar_label: schedule +description: Temporal's Schedule commands allow users to create, update, and manage Workflow Executions seamlessly for automation, supporting commands for creation, backfill, deletion, and more. +toc_max_heading_level: 4 +keywords: + - backfill + - cli reference + - command-line-interface-cli + - schedule + - schedule backfill + - schedule create + - schedule delete + - schedule describe + - schedule list + - schedule toggle + - schedule trigger + - schedule update + - temporal cli + - updates +tags: + - Temporal CLI + - Schedules +--- + +## backfill + +Batch-execute actions that would have run during a specified time interval. +Use this command to fill in Workflow runs from when a Schedule was paused, +before a Schedule was created, from the future, or to re-process a previously +executed interval. + +Backfills require a Schedule ID and the time period covered by the request. +It's best to use the `BufferAll` or `AllowAll` policies to avoid conflicts +and ensure no Workflow Executions are skipped. + +For example: + +``` +temporal schedule backfill \ + --schedule-id "YourScheduleId" \ + --start-time "2022-05-01T00:00:00Z" \ + --end-time "2022-05-31T23:59:59Z" \ + --overlap-policy BufferAll +``` + +The policies include: + +* **AllowAll**: Allow unlimited concurrent Workflow Executions. This + significantly speeds up the backfilling process on systems that support + concurrency. You must ensure running Workflow Executions do not interfere + with each other. +* **BufferAll**: Buffer all incoming Workflow Executions while waiting for + the running Workflow Execution to complete. +* **Skip**: If a previous Workflow Execution is still running, discard new + Workflow Executions. +* **BufferOne**: Same as 'Skip' but buffer a single Workflow Execution to be + run after the previous Execution completes. Discard other Workflow + Executions. +* **CancelOther**: Cancel the running Workflow Execution and replace it with + the incoming new Workflow Execution. +* **TerminateOther**: Terminate the running Workflow Execution and replace + it with the incoming new Workflow Execution. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--end-time** _timestamp_ + +Backfill end time. Required. + +**--overlap-policy** _string-enum_ + +Policy for handling overlapping Workflow Executions. Accepted values: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. (default "Skip") + +**--schedule-id**, **-s** _string_ + +Schedule ID. Required. + +**--start-time** _timestamp_ + +Backfill start time. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## create + +Create a new Schedule on the Temporal Service. A Schedule automatically starts +new Workflow Executions at the times you specify. + +For example: + +``` + temporal schedule create \ + --schedule-id "YourScheduleId" \ + --calendar '{"dayOfWeek":"Fri","hour":"3","minute":"30"}' \ + --workflow-id YourBaseWorkflowIdName \ + --task-queue YourTaskQueue \ + --type YourWorkflowType +``` + +Schedules support any combination of `--calendar`, `--interval`, and `--cron`: + +* Shorthand `--interval` strings. + For example: 45m (every 45 minutes) or 6h/5h (every 6 hours, at the top of + the 5th hour). +* JSON `--calendar`, as in the preceding example. +* Unix-style `--cron` strings and robfig declarations + (@daily/@weekly/@every X/etc). + For example, every Friday at 12:30 PM: `30 12 * * Fri`. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--calendar** _string[]_ + +Calendar specification in JSON. For example: `{"dayOfWeek":"Fri","hour":"17","minute":"5"}`. + +**--catchup-window** _duration_ + +Maximum catch-up time for when the Service is unavailable. + +**--cron** _string[]_ + +Calendar specification in cron string format. For example: `"30 12 * * Fri"`. + +**--end-time** _timestamp_ + +Schedule end time. + +**--execution-timeout** _duration_ + +Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. + +**--input**, **-i** _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** _bool_ + +Assume inputs are base64-encoded and attempt to decode them. + +**--input-file** _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** _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. + +**--interval** _string[]_ + +Interval duration. For example, 90m, or 60m/15m to include phase offset. + +**--jitter** _duration_ + +Max difference in time from the specification. Vary the start time randomly within this amount. + +**--memo** _string[]_ + +Memo using 'KEY="VALUE"' pairs. Use JSON values. + +**--notes** _string_ + +Initial notes field value. + +**--overlap-policy** _string-enum_ + +Policy for handling overlapping Workflow Executions. Accepted values: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. (default "Skip") + +**--pause-on-failure** _bool_ + +Pause schedule after Workflow failures. + +**--paused** _bool_ + +Pause the Schedule immediately on creation. + +**--remaining-actions** _int_ + +Total allowed actions. Default is zero (unlimited). + +**--run-timeout** _duration_ + +Fail a Workflow Run if it lasts longer than `DURATION`. + +**--schedule-id**, **-s** _string_ + +Schedule ID. Required. + +**--schedule-memo** _string[]_ + +Set schedule memo using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. + +**--schedule-search-attribute** _string[]_ + +Set schedule Search Attributes using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. + +**--search-attribute** _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. + +**--start-time** _timestamp_ + +Schedule start time. + +**--static-details** _string_ + +Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. + +:::note + +Option is experimental. + +::: + +**--static-summary** _string_ + +Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. + +:::note + +Option is experimental. + +::: + +**--task-queue**, **-t** _string_ + +Workflow Task queue. Required. + +**--task-timeout** _duration_ + +Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") + +**--time-zone** _string_ + +Interpret calendar specs with the `TZ` time zone. For a list of time zones, see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. + +**--type** _string_ + +Workflow Type name. Required. + +**--workflow-id**, **-w** _string_ + +Workflow ID. If not supplied, the Service generates a unique ID. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## delete + +Deletes a Schedule on the front end Service: + +``` +temporal schedule delete \ + --schedule-id YourScheduleId +``` + +Removing a Schedule won't affect the Workflow Executions it started that are +still running. To cancel or terminate these Workflow Executions, use `temporal +workflow delete` with the `TemporalScheduledById` Search Attribute instead. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--schedule-id**, **-s** _string_ + +Schedule ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## describe + +Show a Schedule configuration, including information about past, current, and +future Workflow runs: + +``` +temporal schedule describe \ + --schedule-id YourScheduleId +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--schedule-id**, **-s** _string_ + +Schedule ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## list + +Lists the Schedules hosted by a Namespace: + +``` +temporal schedule list \ + --namespace YourNamespace +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--long**, **-l** _bool_ + +Show detailed information. + +**--query**, **-q** _string_ + +Filter results using given List Filter. + +**--really-long** _bool_ + +Show extensive information in non-table form. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## toggle + +Pause or unpause a Schedule by passing a flag with your desired state: + +``` +temporal schedule toggle \ + --schedule-id "YourScheduleId" \ + --pause \ + --reason "YourReason" +``` + +and + +``` +temporal schedule toggle + --schedule-id "YourScheduleId" \ + --unpause \ + --reason "YourReason" +``` + +The `--reason` text updates the Schedule's `notes` field for operations +communication. It defaults to "(no reason provided)" if omitted. This field is +also visible on the Service Web UI. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--pause** _bool_ + +Pause the Schedule. + +**--reason** _string_ + +Reason for pausing or unpausing the Schedule. (default "(no reason provided)") + +**--schedule-id**, **-s** _string_ + +Schedule ID. Required. + +**--unpause** _bool_ + +Unpause the Schedule. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## trigger + +Trigger a Schedule to run immediately: + +``` +temporal schedule trigger \ + --schedule-id "YourScheduleId" +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--overlap-policy** _string-enum_ + +Policy for handling overlapping Workflow Executions. Accepted values: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. (default "Skip") + +**--schedule-id**, **-s** _string_ + +Schedule ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## update + +Update an existing Schedule with new configuration details, including time +specifications, action, and policies: + +``` +temporal schedule update \ + --schedule-id "YourScheduleId" \ + --workflow-type "NewWorkflowType" +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--calendar** _string[]_ + +Calendar specification in JSON. For example: `{"dayOfWeek":"Fri","hour":"17","minute":"5"}`. + +**--catchup-window** _duration_ + +Maximum catch-up time for when the Service is unavailable. + +**--cron** _string[]_ + +Calendar specification in cron string format. For example: `"30 12 * * Fri"`. + +**--end-time** _timestamp_ + +Schedule end time. + +**--execution-timeout** _duration_ + +Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. + +**--input**, **-i** _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** _bool_ + +Assume inputs are base64-encoded and attempt to decode them. + +**--input-file** _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** _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. + +**--interval** _string[]_ + +Interval duration. For example, 90m, or 60m/15m to include phase offset. + +**--jitter** _duration_ + +Max difference in time from the specification. Vary the start time randomly within this amount. + +**--memo** _string[]_ + +Memo using 'KEY="VALUE"' pairs. Use JSON values. + +**--notes** _string_ + +Initial notes field value. + +**--overlap-policy** _string-enum_ + +Policy for handling overlapping Workflow Executions. Accepted values: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. (default "Skip") + +**--pause-on-failure** _bool_ + +Pause schedule after Workflow failures. + +**--paused** _bool_ + +Pause the Schedule immediately on creation. + +**--remaining-actions** _int_ + +Total allowed actions. Default is zero (unlimited). + +**--run-timeout** _duration_ + +Fail a Workflow Run if it lasts longer than `DURATION`. + +**--schedule-id**, **-s** _string_ + +Schedule ID. Required. + +**--schedule-memo** _string[]_ + +Set schedule memo using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. + +**--schedule-search-attribute** _string[]_ + +Set schedule Search Attributes using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. + +**--search-attribute** _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. + +**--start-time** _timestamp_ + +Schedule start time. + +**--static-details** _string_ + +Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. + +:::note + +Option is experimental. + +::: + +**--static-summary** _string_ + +Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. + +:::note + +Option is experimental. + +::: + +**--task-queue**, **-t** _string_ + +Workflow Task queue. Required. + +**--task-timeout** _duration_ + +Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") + +**--time-zone** _string_ + +Interpret calendar specs with the `TZ` time zone. For a list of time zones, see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. + +**--type** _string_ + +Workflow Type name. Required. + +**--workflow-id**, **-w** _string_ + +Workflow ID. If not supplied, the Service generates a unique ID. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + diff --git a/temporalcli/docs/server.mdx b/temporalcli/docs/server.mdx new file mode 100644 index 000000000..9588a212f --- /dev/null +++ b/temporalcli/docs/server.mdx @@ -0,0 +1,273 @@ +{/* 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 */} +--- +id: server +title: Temporal CLI server command reference +sidebar_label: server +description: Manage your Temporal Server easily with CLI commands. Start a local server using `temporal server start-dev` and access the Web UI at http://localhost:8233. Customize with multiple options. +toc_max_heading_level: 4 +keywords: + - cli reference + - command-line-interface-cli + - server + - server start-dev + - temporal cli +tags: + - Temporal CLI + - Development Server +--- + +## start-dev + +Run a development Temporal Server on your local system. + ++------------------------------------------------------------------------+ +| WARNING: The development server is not intended for production use. | +| It skips certain HTTP security checks to make local use simpler. | +| | +| For production use, see: | +| https://docs.temporal.io/production-deployment | ++------------------------------------------------------------------------+ + +View the Web UI for the default configuration at: http://localhost:8233 + +``` +temporal server start-dev +``` + +Add persistence for Workflow Executions across runs: + +``` +temporal server start-dev \ + --db-filename path-to-your-local-persistent-store +``` + +Set the port from the front-end gRPC Service (7233 default): + +``` +temporal server start-dev \ + --port 7000 +``` + +Use a custom port for the Web UI. The default is the gRPC port (7233 default) +plus 1000 (8233): + +``` +temporal server start-dev \ + --ui-port 3000 +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--db-filename**, **-f** _string_ + +Path to file for persistent Temporal state store. By default, Workflow Executions are lost when the server process dies. + +**--dynamic-config-value** _string[]_ + +Dynamic configuration value using `KEY=VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey="YourString"'. Can be passed multiple times. + +**--headless** _bool_ + +Disable the Web UI. + +**--http-port** _int_ + +Port for the HTTP API service. Defaults to a random free port. (default "0") + +**--ip** _string_ + +IP address bound to the front-end Service. (default "localhost") + +**--log-config** _bool_ + +Log the server config to stderr. + +**--metrics-port** _int_ + +Port for '/metrics'. Default is off. + +**--namespace**, **-n** _string[]_ + +Namespaces to be created at launch. The "default" Namespace is always created automatically. + +**--port**, **-p** _int_ + +Port for the front-end gRPC Service. (default "7233") + +**--search-attribute** _string[]_ + +Search attributes to register using `KEY=VALUE` pairs. Keys must be identifiers, and values must be the search attribute type, which is one of the following: Text, Keyword, Int, Double, Bool, Datetime, KeywordList. + +**--sqlite-pragma** _string[]_ + +SQLite pragma statements in "PRAGMA=VALUE" format. + +**--ui-asset-path** _string_ + +UI custom assets path. + +**--ui-codec-endpoint** _string_ + +UI remote codec HTTP endpoint. + +**--ui-ip** _string_ + +IP address bound to the Web UI. Default is same as '--ip' value. + +**--ui-port** _int_ + +Port for the Web UI. Default is '--port' value + 1000. + +**--ui-public-path** _string_ + +The public base path for the Web UI. Default is `/`. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + diff --git a/temporalcli/docs/task-queue.mdx b/temporalcli/docs/task-queue.mdx new file mode 100644 index 000000000..9abfcc858 --- /dev/null +++ b/temporalcli/docs/task-queue.mdx @@ -0,0 +1,3026 @@ +{/* 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 */} +--- +id: task-queue +title: Temporal CLI task-queue command reference +sidebar_label: task-queue +description: Temporal Task Queue commands facilitate operations like describing poller info, displaying partitions, fetching compatible Build IDs, and determining Build ID reachability for effective Workflow and Activity management. +toc_max_heading_level: 4 +keywords: + - cli reference + - command-line-interface-cli + - list partitions + - task queue + - task queue describe + - temporal cli +tags: + - Temporal CLI +--- + +## describe + +Display a list of active Workers that have recently polled a Task Queue. The +Temporal Server records each poll request time. A `LastAccessTime` over one +minute may indicate the Worker is at capacity or has shut down. Temporal +Workers are removed if 5 minutes have passed since the last poll request. + +``` +temporal task-queue describe \ + --task-queue YourTaskQueue +``` + +This command provides poller information for a given Task Queue. +Workflow and Activity polling use separate Task Queues: + +``` +temporal task-queue describe \ + --task-queue YourTaskQueue \ + --task-queue-type "activity" +``` + +This command provides the following task queue statistics: +- `ApproximateBacklogCount`: The approximate number of tasks backlogged in this + task queue. May count expired tasks but eventually converges to the right + value. +- `ApproximateBacklogAge`: Approximate age of the oldest task in the backlog, + based on its creation time, measured in seconds. +- `TasksAddRate`: Approximate rate at which tasks are being added to the task + queue, measured in tasks per second, averaged over the last 30 seconds. + Includes tasks dispatched immediately without going to the backlog + (sync-matched tasks), as well as tasks added to the backlog. (See note below.) +- `TasksDispatchRate`: Approximate rate at which tasks are being dispatched from + the task queue, measured in tasks per second, averaged over the last 30 + seconds. Includes tasks dispatched immediately without going to the backlog + (sync-matched tasks), as well as tasks added to the backlog. (See note below.) +- `BacklogIncreaseRate`: Approximate rate at which the backlog size is + increasing (if positive) or decreasing (if negative), measured in tasks per + second, averaged over the last 30 seconds. This is roughly equivalent to: + `TasksAddRate` - `TasksDispatchRate`. + +NOTE: The `TasksAddRate` and `TasksDispatchRate` metrics may differ from the +actual rate of add/dispatch, because tasks may be dispatched eagerly to an +available worker, or may apply only to specific workers (they are "sticky"). +Such tasks are not counted by these metrics. Despite the inaccuracy of +these two metrics, the derived metric of `BacklogIncreaseRate` is accurate +for backlogs older than a few seconds. + +Safely retire Workers assigned a Build ID by checking reachability across +all task types. Use the flag `--report-reachability`: + +``` +temporal task-queue describe \ + --task-queue YourTaskQueue \ + --build-id "YourBuildId" \ + --report-reachability +``` + +Task reachability information is returned for the requested versions and all +task types, which can be used to safely retire Workers with old code versions, +provided that they were assigned a Build ID. + +Note that task reachability status is experimental and may significantly change +or be removed in a future release. Also, determining task reachability incurs a +non-trivial computing cost. + +Task reachability states are reported per build ID. The state may be one of the +following: + +- `Reachable`: using the current versioning rules, the Build ID may be used + by new Workflow Executions or Activities OR there are currently open + Workflow or backlogged Activity tasks assigned to the queue. +- `ClosedWorkflowsOnly`: the Build ID does not have open Workflow Executions + and can't be reached by new Workflow Executions. It MAY have closed + Workflow Executions within the Namespace retention period. +- `Unreachable`: this Build ID is not used for new Workflow Executions and + isn't used by any existing Workflow Execution within the retention period. + +Task reachability is eventually consistent. You may experience a delay until +reachability converges to the most accurate value. This is designed to act +in the most conservative way until convergence. For example, `Reachable` is +more conservative than `ClosedWorkflowsOnly`. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--disable-stats** _bool_ + +Disable task queue statistics. + +**--legacy-mode** _bool_ + +Enable a legacy mode for servers that do not support rules-based worker versioning. This mode only provides pollers info. + +**--partitions-legacy** _int_ + +Query partitions 1 through `N`. Experimental/Temporary feature. Legacy mode only. (default "1") + +**--report-reachability** _bool_ + +Display task reachability information. + +**--select-all-active** _bool_ + +Include all active versions. A version is active if it had new tasks or polls recently. + +**--select-build-id** _string[]_ + +Filter the Task Queue based on Build ID. + +**--select-unversioned** _bool_ + +Include the unversioned queue. + +**--task-queue**, **-t** _string_ + +Task Queue name. Required. + +**--task-queue-type** _string-enum[]_ + +Task Queue type. If not specified, all types are reported. Accepted values: workflow, activity, nexus. + +**--task-queue-type-legacy** _string-enum_ + +Task Queue type (legacy mode only). Accepted values: workflow, activity. (default "workflow") + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## get-build-id-reachability + ++-----------------------------------------------------------------------------+ +| CAUTION: This command is deprecated and will be removed in a later release. | ++-----------------------------------------------------------------------------+ + +Show if a given Build ID can be used for new, existing, or closed Workflows +in Namespaces that support Worker versioning: + +``` +temporal task-queue get-build-id-reachability \ + --task-queue YourTaskQueue \ + --build-id "YourBuildId" +``` + +You can specify the `--build-id` and `--task-queue` flags multiple times. If +`--task-queue` is omitted, the command checks Build ID reachability against +all Task Queues. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string[]_ + +One or more Build ID strings. Can be passed multiple times. + +**--reachability-type** _string-enum_ + +Reachability filter. `open`: reachable by one or more open workflows. `closed`: reachable by one or more closed workflows. `existing`: reachable by either. New Workflow Executions reachable by a Build ID are always reported. Accepted values: open, closed, existing. (default "existing") + +**--task-queue**, **-t** _string[]_ + +Search only the specified task queue(s). Can be passed multiple times. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## get-build-ids + ++-----------------------------------------------------------------------------+ +| CAUTION: This command is deprecated and will be removed in a later release. | ++-----------------------------------------------------------------------------+ + +Fetch sets of compatible Build IDs for specified Task Queues and display their +information: + +``` +temporal task-queue get-build-ids \ + --task-queue YourTaskQueue +``` + +This command is limited to Namespaces that support Worker versioning. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--max-sets** _int_ + +Max return count. Use 1 for default major version. Use 0 for all sets. (default "0") + +**--task-queue**, **-t** _string_ + +Task Queue name. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## list-partition + +Display a Task Queue's partition list with assigned matching nodes: + +``` +temporal task-queue list-partition \ + --task-queue YourTaskQueue +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--task-queue**, **-t** _string_ + +Task Queue name. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## update-build-ids + ++-----------------------------------------------------------------------------+ +| CAUTION: This command is deprecated and will be removed in a later release. | ++-----------------------------------------------------------------------------+ + +Add or change a Task Queue's compatible Build IDs for Namespaces using Worker +versioning: + +``` +temporal task-queue update-build-ids [subcommands] [options] \ + --task-queue YourTaskQueue +``` + +### add-new-compatible + +Add a compatible Build ID to a Task Queue's existing version set. Provide an +existing Build ID and a new Build ID: + +``` +temporal task-queue update-build-ids add-new-compatible \ + --task-queue YourTaskQueue \ + --existing-compatible-build-id "YourExistingBuildId" \ + --build-id "YourNewBuildId" +``` + +The new ID is stored in the set containing the existing ID and becomes the new +default for that set. + +This command is limited to Namespaces that support Worker versioning. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string_ + +Build ID to be added. Required. + +**--existing-compatible-build-id** _string_ + +Pre-existing Build ID in this Task Queue. Required. + +**--set-as-default** _bool_ + +Set the expanded Build ID set as the Task Queue default. + +**--task-queue**, **-t** _string_ + +Task Queue name. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### add-new-default + ++-----------------------------------------------------------------------------+ +| CAUTION: This command is deprecated and will be removed in a later release. | ++-----------------------------------------------------------------------------+ + +Create a new Task Queue Build ID set, add a Build ID to it, and make it the +overall Task Queue default. The new set will be incompatible with previous +sets and versions. + +``` +temporal task-queue update-build-ids add-new-default \ + --task-queue YourTaskQueue \ + --build-id "YourNewBuildId" +``` + ++------------------------------------------------------------------------+ +| NOTICE: This command is limited to Namespaces that support Worker | +| versioning. Worker versioning is experimental. Versioning commands are | +| subject to change. | ++------------------------------------------------------------------------+ + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string_ + +Build ID to be added. Required. + +**--task-queue**, **-t** _string_ + +Task Queue name. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### promote-id-in-set + ++-----------------------------------------------------------------------------+ +| CAUTION: This command is deprecated and will be removed in a later release. | ++-----------------------------------------------------------------------------+ + +Establish an existing Build ID as the default in its Task Queue set. New tasks +compatible with this set will now be dispatched to this ID: + +``` +temporal task-queue update-build-ids promote-id-in-set \ + --task-queue YourTaskQueue \ + --build-id "YourBuildId" +``` + ++------------------------------------------------------------------------+ +| NOTICE: This command is limited to Namespaces that support Worker | +| versioning. Worker versioning is experimental. Versioning commands are | +| subject to change. | ++------------------------------------------------------------------------+ + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string_ + +Build ID to set as default. Required. + +**--task-queue**, **-t** _string_ + +Task Queue name. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### promote-set + ++-----------------------------------------------------------------------------+ +| CAUTION: This command is deprecated and will be removed in a later release. | ++-----------------------------------------------------------------------------+ + +Promote a Build ID set to be the default on a Task Queue. Identify the set by +providing a Build ID within it. If the set is already the default, this +command has no effect: + +``` +temporal task-queue update-build-ids promote-set \ + --task-queue YourTaskQueue \ + --build-id "YourBuildId" +``` + ++------------------------------------------------------------------------+ +| NOTICE: This command is limited to Namespaces that support Worker | +| versioning. Worker versioning is experimental. Versioning commands are | +| subject to change. | ++------------------------------------------------------------------------+ + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string_ + +Build ID within the promoted set. Required. + +**--task-queue**, **-t** _string_ + +Task Queue name. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## versioning + ++---------------------------------------------------------------------+ +| CAUTION: This API has been deprecated by Worker Deployment. | ++---------------------------------------------------------------------+ + +Provides commands to add, list, remove, or replace Worker Build ID assignment +and redirect rules associated with Task Queues: + +``` +temporal task-queue versioning [subcommands] [options] \ + --task-queue YourTaskQueue +``` + +Task Queues support the following versioning rules and policies: + +- Assignment Rules: manage how new executions are assigned to run on specific + Worker Build IDs. Each Task Queue stores a list of ordered Assignment Rules, + which are evaluated from first to last. Assignment Rules also allow for + gradual rollout of new Build IDs by setting ramp percentage. +- Redirect Rules: automatically assign work for a source Build ID to a target + Build ID. You may add at most one redirect rule for each source Build ID. + Redirect rules require that a target Build ID is fully compatible with + the source Build ID. + +### add-redirect-rule + +Add a new redirect rule for a given Task Queue. You may add at most one +redirect rule for each distinct source build ID: + +``` +temporal task-queue versioning add-redirect-rule \ + --task-queue YourTaskQueue \ + --source-build-id "YourSourceBuildID" \ + --target-build-id "YourTargetBuildID" +``` + ++---------------------------------------------------------------------+ +| CAUTION: This API has been deprecated by Worker Deployment. | ++---------------------------------------------------------------------+ + +Use the following options to change the behavior of this command. + +**Flags:** + +**--source-build-id** _string_ + +Source build ID. Required. + +**--target-build-id** _string_ + +Target build ID. Required. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### commit-build-id + +Complete a Build ID's rollout and clean up unnecessary rules that might have +been created during a gradual rollout: + +``` +temporal task-queue versioning commit-build-id \ + --task-queue YourTaskQueue + --build-id "YourBuildId" +``` + +This command automatically applies the following atomic changes: + +- Adds an unconditional assignment rule for the target Build ID at the + end of the list. +- Removes all previously added assignment rules to the given target + Build ID. +- Removes any unconditional assignment rules for other Build IDs. + +Rejects requests when there have been no recent pollers for this Build ID. +This prevents committing invalid Build IDs. Use the `--force` option to +override this validation. + ++---------------------------------------------------------------------+ +| CAUTION: This API has been deprecated by Worker Deployment. | ++---------------------------------------------------------------------+ + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string_ + +Target build ID. Required. + +**--force** _bool_ + +Bypass recent-poller validation. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### delete-assignment-rule + +Deletes a rule identified by its index in the Task Queue's list of assignment +rules. + +``` +temporal task-queue versioning delete-assignment-rule \ + --task-queue YourTaskQueue \ + --rule-index YourIntegerRuleIndex +``` + +By default, the Task Queue must retain one unconditional rule, such as "no +hint filter" or "percentage". Otherwise, the delete operation is rejected. +Use the `--force` option to override this validation. + ++---------------------------------------------------------------------+ +| CAUTION: This API has been deprecated by Worker Deployment. | ++---------------------------------------------------------------------+ + +Use the following options to change the behavior of this command. + +**Flags:** + +**--force** _bool_ + +Bypass one-unconditional-rule validation. + +**--rule-index**, **-i** _int_ + +Position of the assignment rule to be replaced. Requests for invalid indices will fail. Required. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### delete-redirect-rule + +Deletes the routing rule for the given source Build ID. + +``` +temporal task-queue versioning delete-redirect-rule \ + --task-queue YourTaskQueue \ + --source-build-id "YourBuildId" +``` + ++---------------------------------------------------------------------+ +| CAUTION: This API has been deprecated by Worker Deployment. | ++---------------------------------------------------------------------+ + +Use the following options to change the behavior of this command. + +**Flags:** + +**--source-build-id** _string_ + +Source Build ID. Required. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### get-rules + +Retrieve all the Worker Build ID assignments and redirect rules associated +with a Task Queue: + +``` +temporal task-queue versioning get-rules \ + --task-queue YourTaskQueue +``` + +Task Queues support the following versioning rules: + +- Assignment Rules: manage how new executions are assigned to run on specific + Worker Build IDs. Each Task Queue stores a list of ordered Assignment Rules, + which are evaluated from first to last. Assignment Rules also allow for + gradual rollout of new Build IDs by setting ramp percentage. +- Redirect Rules: automatically assign work for a source Build ID to a target + Build ID. You may add at most one redirect rule for each source Build ID. + Redirect rules require that a target Build ID is fully compatible with + the source Build ID. ++---------------------------------------------------------------------+ +| CAUTION: This API has been deprecated by Worker Deployment. | ++---------------------------------------------------------------------+ + +Use the following options to change the behavior of this command. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### insert-assignment-rule + +Inserts a new assignment rule for this Task Queue. Rules are evaluated in +order, starting from index 0. The first applicable rule is applied, and the +rest ignored: + +``` +temporal task-queue versioning insert-assignment-rule \ + --task-queue YourTaskQueue \ + --build-id "YourBuildId" +``` + +If you do not specify a `--rule-index`, this command inserts at index 0. + ++---------------------------------------------------------------------+ +| CAUTION: This API has been deprecated by Worker Deployment. | ++---------------------------------------------------------------------+ + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string_ + +Target Build ID. Required. + +**--percentage** _int_ + +Traffic percent to send to target Build ID. (default "100") + +**--rule-index**, **-i** _int_ + +Insertion position. Ranges from 0 (insert at start) to count (append). Any number greater than the count is treated as "append". (default "0") + +**--yes**, **-y** _bool_ + +Don't prompt to confirm. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### replace-assignment-rule + +Change an assignment rule for this Task Queue. By default, this enforces one +unconditional rule (no hint filter or percentage). Otherwise, the operation +will be rejected. Set `force` to true to bypass this validation. + +``` +temporal task-queue versioning replace-assignment-rule \ + --task-queue YourTaskQueue \ + --rule-index AnIntegerIndex \ + --build-id "YourBuildId" +``` + +To assign multiple assignment rules to a single Build ID, use +'insert-assignment-rule'. + +To update the percent: + +``` +temporal task-queue versioning replace-assignment-rule \ + --task-queue YourTaskQueue \ + --rule-index AnIntegerIndex \ + --build-id "YourBuildId" \ + --percentage AnIntegerPercent +``` + +Percent may vary between 0 and 100 (default). + ++---------------------------------------------------------------------+ +| CAUTION: This API has been deprecated by Worker Deployment. | ++---------------------------------------------------------------------+ + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string_ + +Target Build ID. Required. + +**--force** _bool_ + +Bypass the validation that one unconditional rule remains. + +**--percentage** _int_ + +Divert percent of traffic to target Build ID. (default "100") + +**--rule-index**, **-i** _int_ + +Position of the assignment rule to be replaced. Requests for invalid indices will fail. Required. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### replace-redirect-rule + +Updates a Build ID's redirect rule on a Task Queue by replacing its target +Build ID: + +``` +temporal task-queue versioning replace-redirect-rule \ + --task-queue YourTaskQueue \ + --source-build-id YourSourceBuildId \ + --target-build-id YourNewTargetBuildId +``` + ++---------------------------------------------------------------------+ +| CAUTION: This API has been deprecated by Worker Deployment. | ++---------------------------------------------------------------------+ + +Use the following options to change the behavior of this command. + +**Flags:** + +**--source-build-id** _string_ + +Source Build ID. Required. + +**--target-build-id** _string_ + +Target Build ID. Required. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + diff --git a/temporalcli/docs/worker.mdx b/temporalcli/docs/worker.mdx new file mode 100644 index 000000000..bf9f0ce68 --- /dev/null +++ b/temporalcli/docs/worker.mdx @@ -0,0 +1,1581 @@ +{/* 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 */} +--- +id: worker +title: Temporal CLI worker command reference +sidebar_label: worker +description: Learn how to read or modify state associated with a Worker, such as Worker Deployments. +toc_max_heading_level: 4 +keywords: + - worker + - worker deployment +tags: + - Temporal CLI +--- + +## deployment + ++---------------------------------------------------------------------+ +| CAUTION: Worker Deployment is experimental. Deployment commands are | +| subject to change. | ++---------------------------------------------------------------------+ + +Deployment commands perform operations on Worker Deployments: + +``` +temporal worker deployment [command] [options] +``` + +For example: + +``` +temporal worker deployment list +``` + +Lists the Deployments in the client's namespace. + +Arguments can be Worker Deployment Versions associated with +a Deployment, specified using the Deployment name and Build ID. + +For example: + +``` +temporal worker deployment set-current-version \ + --deployment-name YourDeploymentName --build-id YourBuildID +``` + +Sets the current Deployment Version for a given Deployment. + +### delete + ++---------------------------------------------------------------------+ +| CAUTION: Worker Deployment is experimental. Deployment commands are | +| subject to change. | ++---------------------------------------------------------------------+ + +Remove a Worker Deployment given its Deployment Name. +A Deployment can only be deleted if it has no Version in it. + +``` +temporal worker deployment delete [options] +``` + +For example, setting the user identity that removed the deployment: + +``` +temporal worker deployment delete \ + --name YourDeploymentName \ + --identity YourIdentity + +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--identity** _string_ + +Identity of the user submitting this request. + +**--name**, **-d** _string_ + +Name for a Worker Deployment. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### delete-version + ++---------------------------------------------------------------------+ +| CAUTION: Worker Deployment is experimental. Deployment commands are | +| subject to change. | ++---------------------------------------------------------------------+ + +Remove a Worker Deployment Version given its fully-qualified identifier. +This is rarely needed during normal operation +since unused Versions are eventually garbage collected. +The client can delete a Version only when all of the following conditions +are met: + - It is not the Current or Ramping Version for this Deployment. + - It has no active pollers, i.e., none of the task queues in the + Version have pollers. + - It is not draining. This requirement can be ignored with the option +`--skip-drainage`. +``` +temporal worker deployment delete-version [options] +``` + +For example, skipping the drainage restriction: + +``` +temporal worker deployment delete-version \ + --deployment-name YourDeploymentName --build-id YourBuildID \ + --skip-drainage +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string_ + +Build ID of the Worker Deployment Version. Required. + +**--deployment-name** _string_ + +Name of the Worker Deployment. Required. + +**--identity** _string_ + +Identity of the user submitting this request. + +**--skip-drainage** _bool_ + +Ignore the deletion requirement of not draining. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### describe + ++---------------------------------------------------------------------+ +| CAUTION: Worker Deployment is experimental. Deployment commands are | +| subject to change. | ++---------------------------------------------------------------------+ + +Describe properties of a Worker Deployment, such as the versions +associated with it, routing information of new or existing tasks +executed by this deployment, or its creation time. + +``` +temporal worker deployment describe [options] +``` + +For example, to describe a deployment `YourDeploymentName` in the default +namespace: + +``` +temporal worker deployment describe \ + --name YourDeploymentName +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--name**, **-d** _string_ + +Name for a Worker Deployment. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### describe-version + ++---------------------------------------------------------------------+ +| CAUTION: Worker Deployment is experimental. Deployment commands are | +| subject to change. | ++---------------------------------------------------------------------+ + +Describe properties of a Worker Deployment Version, such as the task +queues polled by workers in this Deployment Version, or drainage +information required to safely decommission workers, or user-provided +metadata, or its creation/modification time. + +``` +temporal worker deployment describe-version [options] +``` + +For example, to describe a deployment version in a deployment +`YourDeploymentName`, with Build ID `YourBuildID`, and in the default +namespace: + +``` +temporal worker deployment describe-version \ + --deployment-name YourDeploymentName --build-id YourBuildID +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string_ + +Build ID of the Worker Deployment Version. Required. + +**--deployment-name** _string_ + +Name of the Worker Deployment. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### list + ++---------------------------------------------------------------------+ +| CAUTION: Worker Deployment is experimental. Deployment commands are | +| subject to change. | ++---------------------------------------------------------------------+ + +List existing Worker Deployments in the client's namespace. + +``` +temporal worker deployment list [options] +``` + +For example, listing Deployments in YourDeploymentNamespace: + +``` +temporal worker deployment list \ + --namespace YourDeploymentNamespace +``` + +Use the following options to change the behavior of this command. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### set-current-version + ++---------------------------------------------------------------------+ +| CAUTION: Worker Deployment is experimental. Deployment commands are | +| subject to change. | ++---------------------------------------------------------------------+ + +Set the Current Version for a Deployment. +When a Version is current, Workers of that Deployment Version will receive +tasks from new Workflows, and from existing AutoUpgrade Workflows that +are running on this Deployment. + +If not all the expected Task Queues are being polled by Workers in the +new Version the request will fail. To override this protection use +`--ignore-missing-task-queues`. Note that this would ignore task queues +in a deployment that are not yet discovered, leading to inconsistent task +queue configuration. + +``` +temporal worker deployment set-current-version [options] +``` + +For example, to set the Current Version of a deployment +`YourDeploymentName`, with a version with Build ID `YourBuildID`, and +in the default namespace: + +``` +temporal worker deployment set-current-version \ + --deployment-name YourDeploymentName --build-id YourBuildID +``` + +The target of set-current-version can also be unversioned workers: + +``` +temporal worker deployment set-current-version \ + --deployment-name YourDeploymentName --unversioned +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string_ + +Build ID of the Worker Deployment Version. Required unless --unversioned is specified. + +**--deployment-name** _string_ + +Name of the Worker Deployment. Required. + +**--identity** _string_ + +Identity of the user submitting this request. + +**--ignore-missing-task-queues** _bool_ + +Override protection to accidentally remove task queues. + +**--unversioned** _bool_ + +Set unversioned workers as the target version. Cannot be used with --build-id. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm set Current Version. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### set-ramping-version + ++---------------------------------------------------------------------+ +| CAUTION: Worker Deployment is experimental. Deployment commands are | +| subject to change. | ++---------------------------------------------------------------------+ + +Set the Ramping Version and Percentage for a Deployment. + +The Ramping Version can be set using deployment name and build ID, +or set to unversioned workers using the --unversioned flag. + +The Ramping Percentage is a float with values in the range [0, 100]. +A value of 100 does not make the Ramping Version Current, use +`set-current-version` instead. + +To remove a Ramping Version use the flag `--delete`. + +If not all the expected Task Queues are being polled by Workers in the +new Ramping Version the request will fail. To override this protection use +`--ignore-missing-task-queues`. Note that this would ignore task queues +in a deployment that are not yet discovered, leading to inconsistent task +queue configuration. + +``` +temporal worker deployment set-ramping-version [options] +``` + +For example, to set the Ramping Version of a deployment +`YourDeploymentName`, with a version with Build ID `YourBuildID`, with +10 percent of tasks redirected to this version, and +using the default namespace: + +``` +temporal worker deployment set-ramping-version \ + --deployment-name YourDeploymentName --build-id YourBuildID \ + --percentage 10.0 +``` + +And to remove that ramping: +``` +temporal worker deployment set-ramping-version \ + --deployment-name YourDeploymentName --build-id YourBuildID \ + --delete +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string_ + +Build ID of the Worker Deployment Version. Required unless --unversioned is specified. + +**--delete** _bool_ + +Delete the Ramping Version. + +**--deployment-name** _string_ + +Name of the Worker Deployment. Required. + +**--identity** _string_ + +Identity of the user submitting this request. + +**--ignore-missing-task-queues** _bool_ + +Override protection to accidentally remove task queues. + +**--percentage** _float_ + +Percentage of tasks redirected to the Ramping Version. Valid range [0,100]. + +**--unversioned** _bool_ + +Set unversioned workers as the target version. Cannot be used with --build-id. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm set Ramping Version. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### update-metadata-version + ++---------------------------------------------------------------------+ +| CAUTION: Worker Deployment is experimental. Deployment commands are | +| subject to change. | ++---------------------------------------------------------------------+ +Update metadata associated with a Worker Deployment Version. + +For example: + +``` + temporal worker deployment update-metadata-version \ + --deployment-name YourDeploymentName --build-id YourBuildID \ + --metadata bar=1 \ + --metadata foo=true +``` + +The current metadata is also returned with `describe-version`: +``` + temporal worker deployment describe-version \ + --deployment-name YourDeploymentName --build-id YourBuildID \ +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--build-id** _string_ + +Build ID of the Worker Deployment Version. Required. + +**--deployment-name** _string_ + +Name of the Worker Deployment. Required. + +**--metadata** _string[]_ + +Set deployment metadata using `KEY="VALUE"` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. + +**--remove-entries** _string[]_ + +Keys of entries to be deleted from metadata. Can be passed multiple times. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + diff --git a/temporalcli/docs/workflow.mdx b/temporalcli/docs/workflow.mdx new file mode 100644 index 000000000..f1c093fb4 --- /dev/null +++ b/temporalcli/docs/workflow.mdx @@ -0,0 +1,5172 @@ +{/* 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 */} +--- +id: workflow +title: Temporal CLI workflow command reference +sidebar_label: workflow +description: Temporal Workflow commands enable operations on Workflow Executions, such as cancel, count, delete, describe, execute, list, update-options, query, reset, reset-batch, show, signal, stack, start, terminate, trace, and update, enhancing efficiency and control. +toc_max_heading_level: 4 +keywords: + - call stack + - cancellation + - child workflows + - cli reference + - command-line-interface-cli + - event history + - query + - resets-feature + - signals + - signals-feature + - stack trace + - temporal cli + - termination + - workflow + - workflow cancel + - workflow count + - workflow delete + - workflow describe + - workflow execute + - workflow execution + - workflow list + - workflow metadata + - workflow query + - workflow reset + - workflow reset-batch + - workflow show + - workflow signal + - workflow stack + - workflow start + - workflow terminate + - workflow trace + - workflow update-options +tags: + - Temporal CLI + - Workflows +--- + +## cancel + +Canceling a running Workflow Execution records a +`WorkflowExecutionCancelRequested` event in the Event History. The Service +schedules a new Command Task, and the Workflow Execution performs any cleanup +work supported by its implementation. + +Use the Workflow ID to cancel an Execution: + +``` +temporal workflow cancel \ + --workflow-id YourWorkflowId +``` + +A visibility Query lets you send bulk cancellations to Workflow Executions +matching the results: + +``` +temporal workflow cancel \ + --query YourQuery +``` + +Visit https://docs.temporal.io/visibility to read more about Search Attributes +and Query creation. See `temporal batch --help` for a quick reference. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--query**, **-q** _string_ + +Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. + +**--reason** _string_ + +Reason for batch operation. Only use with --query. Defaults to user name. + +**--rps** _float_ + +Limit batch's requests per second. Only allowed if query is present. + +**--run-id**, **-r** _string_ + +Run ID. Only use with --workflow-id. Cannot use with --query. + +**--workflow-id**, **-w** _string_ + +Workflow ID. You must set either --workflow-id or --query. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm signaling. Only allowed when --query is present. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## count + +Show a count of Workflow Executions, regardless of execution state (running, +terminated, etc). Use `--query` to select a subset of Workflow Executions: + +``` +temporal workflow count \ + --query YourQuery +``` + +Visit https://docs.temporal.io/visibility to read more about Search Attributes +and Query creation. See `temporal batch --help` for a quick reference. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--query**, **-q** _string_ + +Content for an SQL-like `QUERY` List Filter. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## delete + +Delete a Workflow Executions and its Event History: + +``` +temporal workflow delete \ + --workflow-id YourWorkflowId +``` + +The removal executes asynchronously. If the Execution is Running, the Service +terminates it before deletion. + +Visit https://docs.temporal.io/visibility to read more about Search Attributes +and Query creation. See `temporal batch --help` for a quick reference. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--query**, **-q** _string_ + +Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. + +**--reason** _string_ + +Reason for batch operation. Only use with --query. Defaults to user name. + +**--rps** _float_ + +Limit batch's requests per second. Only allowed if query is present. + +**--run-id**, **-r** _string_ + +Run ID. Only use with --workflow-id. Cannot use with --query. + +**--workflow-id**, **-w** _string_ + +Workflow ID. You must set either --workflow-id or --query. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm signaling. Only allowed when --query is present. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## describe + +Display information about a specific Workflow Execution: + +``` +temporal workflow describe \ + --workflow-id YourWorkflowId +``` + +Show the Workflow Execution's auto-reset points: + +``` +temporal workflow describe \ + --workflow-id YourWorkflowId \ + --reset-points true +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--raw** _bool_ + +Print properties without changing their format. + +**--reset-points** _bool_ + +Show auto-reset points only. + +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## execute + +Establish a new Workflow Execution and direct its progress to stdout. The +command blocks and returns when the Workflow Execution completes. If your +Workflow requires input, pass valid JSON: + +``` +temporal workflow execute + --workflow-id YourWorkflowId \ + --type YourWorkflow \ + --task-queue YourTaskQueue \ + --input '{"some-key": "some-value"}' +``` + +Use `--event-details` to relay updates to the command-line output in JSON +format. When using JSON output (`--output json`), this includes the entire +"history" JSON key for the run. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--cron** _string_ + +Cron schedule for the Workflow. + +**--detailed** _bool_ + +Display events as sections instead of table. Does not apply to JSON output. + +**--execution-timeout** _duration_ + +Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. + +**--fail-existing** _bool_ + +Fail if the Workflow already exists. + +**--id-conflict-policy** _string-enum_ + +Determines how to resolve a conflict when spawning a new Workflow Execution with a particular Workflow Id used by an existing Open Workflow Execution. Accepted values: Fail, UseExisting, TerminateExisting. + +**--id-reuse-policy** _string-enum_ + +Re-use policy for the Workflow ID in new Workflow Executions. Accepted values: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. + +**--input**, **-i** _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** _bool_ + +Assume inputs are base64-encoded and attempt to decode them. + +**--input-file** _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** _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. + +**--memo** _string[]_ + +Memo using 'KEY="VALUE"' pairs. Use JSON values. + +**--run-timeout** _duration_ + +Fail a Workflow Run if it lasts longer than `DURATION`. + +**--search-attribute** _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. + +**--start-delay** _duration_ + +Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. + +**--static-details** _string_ + +Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. + +:::note + +Option is experimental. + +::: + +**--static-summary** _string_ + +Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. + +:::note + +Option is experimental. + +::: + +**--task-queue**, **-t** _string_ + +Workflow Task queue. Required. + +**--task-timeout** _duration_ + +Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") + +**--type** _string_ + +Workflow Type name. Required. + +**--workflow-id**, **-w** _string_ + +Workflow ID. If not supplied, the Service generates a unique ID. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## execute-update-with-start + +Send a message to a Workflow Execution to invoke an Update handler, and wait for +the update to complete. If the Workflow Execution is not running, then a new workflow +execution is started and the update is sent. + +Experimental. + +``` +temporal workflow execute-update-with-start \ + --update-name YourUpdate \ + --update-input '{"update-key": "update-value"}' \ + --workflow-id YourWorkflowId \ + --type YourWorkflowType \ + --task-queue YourTaskQueue \ + --id-conflict-policy Fail \ + --input '{"wf-key": "wf-value"}' +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--cron** _string_ + +Cron schedule for the Workflow. + +**--execution-timeout** _duration_ + +Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. + +**--fail-existing** _bool_ + +Fail if the Workflow already exists. + +**--id-conflict-policy** _string-enum_ + +Determines how to resolve a conflict when spawning a new Workflow Execution with a particular Workflow Id used by an existing Open Workflow Execution. Accepted values: Fail, UseExisting, TerminateExisting. + +**--id-reuse-policy** _string-enum_ + +Re-use policy for the Workflow ID in new Workflow Executions. Accepted values: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. + +**--input**, **-i** _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** _bool_ + +Assume inputs are base64-encoded and attempt to decode them. + +**--input-file** _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** _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. + +**--memo** _string[]_ + +Memo using 'KEY="VALUE"' pairs. Use JSON values. + +**--run-id**, **-r** _string_ + +Run ID. If unset, looks for an Update against the currently-running Workflow Execution. + +**--run-timeout** _duration_ + +Fail a Workflow Run if it lasts longer than `DURATION`. + +**--search-attribute** _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. + +**--start-delay** _duration_ + +Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. + +**--static-details** _string_ + +Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. + +:::note + +Option is experimental. + +::: + +**--static-summary** _string_ + +Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. + +:::note + +Option is experimental. + +::: + +**--task-queue**, **-t** _string_ + +Workflow Task queue. Required. + +**--task-timeout** _duration_ + +Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") + +**--type** _string_ + +Workflow Type name. Required. + +**--update-first-execution-run-id** _string_ + +Parent Run ID. The update is sent to the last Workflow Execution in the chain started with this Run ID. + +**--update-id** _string_ + +Update ID. If unset, defaults to a UUID. + +**--update-input** _string[]_ + +Update input value. Use JSON content or set --update-input-meta to override. Can't be combined with --update-input-file. Can be passed multiple times to pass multiple arguments. + +**--update-input-base64** _bool_ + +Assume update inputs are base64-encoded and attempt to decode them. + +**--update-input-file** _string[]_ + +A path or paths for input file(s). Use JSON content or set --update-input-meta to override. Can't be combined with --update-input. Can be passed multiple times to pass multiple arguments. + +**--update-input-meta** _string[]_ + +Input update payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. + +**--update-name** _string_ + +Update name. Required. + +**--workflow-id**, **-w** _string_ + +Workflow ID. If not supplied, the Service generates a unique ID. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## fix-history-json + +Reserialize an Event History JSON file: + +``` +temporal workflow fix-history-json \ + --source /path/to/original.json \ + --target /path/to/reserialized.json +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--source**, **-s** _string_ + +Path to the original file. Required. + +**--target**, **-t** _string_ + +Path to the results file. When omitted, output is sent to stdout. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## list + +List Workflow Executions. The optional `--query` limits the output to +Workflows matching a Query: + +``` +temporal workflow list \ + --query YourQuery` +``` + +Visit https://docs.temporal.io/visibility to read more about Search Attributes +and Query creation. See `temporal batch --help` for a quick reference. + +View a list of archived Workflow Executions: + +``` +temporal workflow list \ + --archived +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--archived** _bool_ + +Limit output to archived Workflow Executions. + +:::note + +Option is experimental. + +::: + +**--limit** _int_ + +Maximum number of Workflow Executions to display. + +**--page-size** _int_ + +Maximum number of Workflow Executions to fetch at a time from the server. + +**--query**, **-q** _string_ + +Content for an SQL-like `QUERY` List Filter. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## metadata + +Issue a Query for and display user-set metadata like summary and +details for a specific Workflow Execution: + +``` +temporal workflow metadata \ + --workflow-id YourWorkflowId +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--reject-condition** _string-enum_ + +Optional flag for rejecting Queries based on Workflow state. Accepted values: not_open, not_completed_cleanly. + +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## query + +Send a Query to a Workflow Execution by Workflow ID to retrieve its state. +This synchronous operation exposes the internal state of a running Workflow +Execution, which constantly changes. You can query both running and completed +Workflow Executions: + +``` +temporal workflow query \ + --workflow-id YourWorkflowId + --type YourQueryType + --input '{"YourInputKey": "YourInputValue"}' +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--input**, **-i** _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** _bool_ + +Assume inputs are base64-encoded and attempt to decode them. + +**--input-file** _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** _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. + +**--name** _string_ + +Query Type/Name. Required. + +**--reject-condition** _string-enum_ + +Optional flag for rejecting Queries based on Workflow state. Accepted values: not_open, not_completed_cleanly. + +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## reset + +Reset a Workflow Execution so it can resume from a point in its Event History +without losing its progress up to that point: + +``` +temporal workflow reset \ + --workflow-id YourWorkflowId \ + --event-id YourLastEvent +``` + +Start from where the Workflow Execution last continued as new: + +``` +temporal workflow reset \ + --workflow-id YourWorkflowId \ + --type LastContinuedAsNew +``` + +For batch resets, limit your resets to FirstWorkflowTask, LastWorkflowTask, or +BuildId. Do not use Workflow IDs, run IDs, or event IDs with this command. + +Visit https://docs.temporal.io/visibility to read more about Search +Attributes and Query creation. + +### with-workflow-update-options + +Run Workflow Update Options atomically after the Workflow is reset. +Workflows selected by the reset command are forwarded onto the subcommand. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--versioning-override-behavior** _string-enum_ + +Override the versioning behavior of a Workflow. Required. Accepted values: pinned, auto_upgrade. + +**--versioning-override-build-id** _string_ + +When overriding to a `pinned` behavior, specifies the Build ID of the version to target. + +**--versioning-override-deployment-name** _string_ + +When overriding to a `pinned` behavior, specifies the Deployment Name of the version to target. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## result + +Wait for and print the result of a Workflow Execution: + +``` +temporal workflow result \ + --workflow-id YourWorkflowId +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## show + +Show a Workflow Execution's Event History. +When using JSON output (`--output json`), you may pass the results to an SDK +to perform a replay: + +``` +temporal workflow show \ + --workflow-id YourWorkflowId + --output json +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--detailed** _bool_ + +Display events as detailed sections instead of table. Does not apply to JSON output. + +**--follow**, **-f** _bool_ + +Follow the Workflow Execution progress in real time. Does not apply to JSON output. + +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## signal + +Send an asynchronous notification (Signal) to a running Workflow Execution by +its Workflow ID. The Signal is written to the History. When you include +`--input`, that data is available for the Workflow Execution to consume: + +``` +temporal workflow signal \ + --workflow-id YourWorkflowId \ + --name YourSignal \ + --input '{"YourInputKey": "YourInputValue"}' +``` + +Visit https://docs.temporal.io/visibility to read more about Search Attributes +and Query creation. See `temporal batch --help` for a quick reference. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--input**, **-i** _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** _bool_ + +Assume inputs are base64-encoded and attempt to decode them. + +**--input-file** _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** _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. + +**--name** _string_ + +Signal name. Required. + +**--query**, **-q** _string_ + +Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. + +**--reason** _string_ + +Reason for batch operation. Only use with --query. Defaults to user name. + +**--rps** _float_ + +Limit batch's requests per second. Only allowed if query is present. + +**--run-id**, **-r** _string_ + +Run ID. Only use with --workflow-id. Cannot use with --query. + +**--workflow-id**, **-w** _string_ + +Workflow ID. You must set either --workflow-id or --query. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm signaling. Only allowed when --query is present. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## signal-with-start + +Send an asynchronous notification (Signal) to a Workflow Execution. +If the Workflow Execution is not running or is not found, it starts the +workflow then sends the signal. + +``` +temporal workflow signal-with-start \ + --signal-name YourSignal \ + --signal-input '{"some-key": "some-value"}' \ + --workflow-id YourWorkflowId \ + --type YourWorkflowType \ + --task-queue YourTaskQueue \ + --input '{"some-key": "some-value"}' +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--cron** _string_ + +Cron schedule for the Workflow. + +**--execution-timeout** _duration_ + +Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. + +**--fail-existing** _bool_ + +Fail if the Workflow already exists. + +**--id-conflict-policy** _string-enum_ + +Determines how to resolve a conflict when spawning a new Workflow Execution with a particular Workflow Id used by an existing Open Workflow Execution. Accepted values: Fail, UseExisting, TerminateExisting. + +**--id-reuse-policy** _string-enum_ + +Re-use policy for the Workflow ID in new Workflow Executions. Accepted values: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. + +**--input**, **-i** _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** _bool_ + +Assume inputs are base64-encoded and attempt to decode them. + +**--input-file** _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** _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. + +**--memo** _string[]_ + +Memo using 'KEY="VALUE"' pairs. Use JSON values. + +**--run-timeout** _duration_ + +Fail a Workflow Run if it lasts longer than `DURATION`. + +**--search-attribute** _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. + +**--signal-input** _string[]_ + +Signal input value. Use JSON content or set --signal-input-meta to override. Can't be combined with --signal-input-file. Can be passed multiple times to pass multiple arguments. + +**--signal-input-base64** _bool_ + +Assume signal inputs are base64-encoded and attempt to decode them. + +**--signal-input-file** _string[]_ + +A path or paths for input file(s). Use JSON content or set --signal-input-meta to override. Can't be combined with --signal-input. Can be passed multiple times to pass multiple arguments. + +**--signal-input-meta** _string[]_ + +Input signal payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. + +**--signal-name** _string_ + +Signal name. Required. + +**--start-delay** _duration_ + +Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. + +**--static-details** _string_ + +Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. + +:::note + +Option is experimental. + +::: + +**--static-summary** _string_ + +Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. + +:::note + +Option is experimental. + +::: + +**--task-queue**, **-t** _string_ + +Workflow Task queue. Required. + +**--task-timeout** _duration_ + +Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") + +**--type** _string_ + +Workflow Type name. Required. + +**--workflow-id**, **-w** _string_ + +Workflow ID. If not supplied, the Service generates a unique ID. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## stack + +Perform a Query on a Workflow Execution using a `__stack_trace`-type Query. +Display a stack trace of the threads and routines currently in use by the +Workflow for troubleshooting: + +``` +temporal workflow stack \ + --workflow-id YourWorkflowId +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--reject-condition** _string-enum_ + +Optional flag to reject Queries based on Workflow state. Accepted values: not_open, not_completed_cleanly. + +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## start + +Start a new Workflow Execution. Returns the Workflow- and Run-IDs: + +``` +temporal workflow start \ + --workflow-id YourWorkflowId \ + --type YourWorkflow \ + --task-queue YourTaskQueue \ + --input '{"some-key": "some-value"}' +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--cron** _string_ + +Cron schedule for the Workflow. + +**--execution-timeout** _duration_ + +Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. + +**--fail-existing** _bool_ + +Fail if the Workflow already exists. + +**--id-conflict-policy** _string-enum_ + +Determines how to resolve a conflict when spawning a new Workflow Execution with a particular Workflow Id used by an existing Open Workflow Execution. Accepted values: Fail, UseExisting, TerminateExisting. + +**--id-reuse-policy** _string-enum_ + +Re-use policy for the Workflow ID in new Workflow Executions. Accepted values: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. + +**--input**, **-i** _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** _bool_ + +Assume inputs are base64-encoded and attempt to decode them. + +**--input-file** _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** _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. + +**--memo** _string[]_ + +Memo using 'KEY="VALUE"' pairs. Use JSON values. + +**--run-timeout** _duration_ + +Fail a Workflow Run if it lasts longer than `DURATION`. + +**--search-attribute** _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. + +**--start-delay** _duration_ + +Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. + +**--static-details** _string_ + +Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. + +:::note + +Option is experimental. + +::: + +**--static-summary** _string_ + +Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. + +:::note + +Option is experimental. + +::: + +**--task-queue**, **-t** _string_ + +Workflow Task queue. Required. + +**--task-timeout** _duration_ + +Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") + +**--type** _string_ + +Workflow Type name. Required. + +**--workflow-id**, **-w** _string_ + +Workflow ID. If not supplied, the Service generates a unique ID. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## start-update-with-start + +Send a message to a Workflow Execution to invoke an Update handler, and wait for +the update to be accepted or rejected. If the Workflow Execution is not running, +then a new workflow execution is started and the update is sent. + +Experimental. + +``` +temporal workflow start-update-with-start \ + --update-name YourUpdate \ + --update-input '{"update-key": "update-value"}' \ + --update-wait-for-stage accepted \ + --workflow-id YourWorkflowId \ + --type YourWorkflowType \ + --task-queue YourTaskQueue \ + --id-conflict-policy Fail \ + --input '{"wf-key": "wf-value"}' +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--cron** _string_ + +Cron schedule for the Workflow. + +**--execution-timeout** _duration_ + +Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. + +**--fail-existing** _bool_ + +Fail if the Workflow already exists. + +**--id-conflict-policy** _string-enum_ + +Determines how to resolve a conflict when spawning a new Workflow Execution with a particular Workflow Id used by an existing Open Workflow Execution. Accepted values: Fail, UseExisting, TerminateExisting. + +**--id-reuse-policy** _string-enum_ + +Re-use policy for the Workflow ID in new Workflow Executions. Accepted values: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. + +**--input**, **-i** _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** _bool_ + +Assume inputs are base64-encoded and attempt to decode them. + +**--input-file** _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** _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. + +**--memo** _string[]_ + +Memo using 'KEY="VALUE"' pairs. Use JSON values. + +**--run-id**, **-r** _string_ + +Run ID. If unset, looks for an Update against the currently-running Workflow Execution. + +**--run-timeout** _duration_ + +Fail a Workflow Run if it lasts longer than `DURATION`. + +**--search-attribute** _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. + +**--start-delay** _duration_ + +Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. + +**--static-details** _string_ + +Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. + +:::note + +Option is experimental. + +::: + +**--static-summary** _string_ + +Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. + +:::note + +Option is experimental. + +::: + +**--task-queue**, **-t** _string_ + +Workflow Task queue. Required. + +**--task-timeout** _duration_ + +Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") + +**--type** _string_ + +Workflow Type name. Required. + +**--update-first-execution-run-id** _string_ + +Parent Run ID. The update is sent to the last Workflow Execution in the chain started with this Run ID. + +**--update-id** _string_ + +Update ID. If unset, defaults to a UUID. + +**--update-input** _string[]_ + +Update input value. Use JSON content or set --update-input-meta to override. Can't be combined with --update-input-file. Can be passed multiple times to pass multiple arguments. + +**--update-input-base64** _bool_ + +Assume update inputs are base64-encoded and attempt to decode them. + +**--update-input-file** _string[]_ + +A path or paths for input file(s). Use JSON content or set --update-input-meta to override. Can't be combined with --update-input. Can be passed multiple times to pass multiple arguments. + +**--update-input-meta** _string[]_ + +Input update payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. + +**--update-name** _string_ + +Update name. Required. + +**--update-wait-for-stage** _string-enum_ + +Update stage to wait for. The only option is `accepted`, but this option is required. This is to allow a future version of the CLI to choose a default value. Required. Accepted values: accepted. + +**--workflow-id**, **-w** _string_ + +Workflow ID. If not supplied, the Service generates a unique ID. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## terminate + +Terminate a Workflow Execution: + +``` +temporal workflow terminate \ + --reason YourReasonForTermination \ + --workflow-id YourWorkflowId +``` + +The reason is optional and defaults to the current user's name. The reason +is stored in the Event History as part of the `WorkflowExecutionTerminated` +event. This becomes the closing Event in the Workflow Execution's history. + +Executions may be terminated in bulk via a visibility Query list filter: + +``` +temporal workflow terminate \ + --query YourQuery \ + --reason YourReasonForTermination +``` + +Workflow code cannot see or respond to terminations. To perform clean-up work +in your Workflow code, use `temporal workflow cancel` instead. + +Visit https://docs.temporal.io/visibility to read more about Search Attributes +and Query creation. See `temporal batch --help` for a quick reference. + +Use the following options to change the behavior of this command. + +**Flags:** + +**--query**, **-q** _string_ + +Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. + +**--reason** _string_ + +Reason for termination. Defaults to message with the current user's name. + +**--rps** _float_ + +Limit batch's requests per second. Only allowed if query is present. + +**--run-id**, **-r** _string_ + +Run ID. Can only be set with --workflow-id. Do not use with --query. + +**--workflow-id**, **-w** _string_ + +Workflow ID. You must set either --workflow-id or --query. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm termination. Can only be used with --query. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## trace + +Display the progress of a Workflow Execution and its child workflows with a +real-time trace. This view helps you understand how Workflows are proceeding: + +``` +temporal workflow trace \ + --workflow-id YourWorkflowId +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--concurrency** _int_ + +Number of Workflow Histories to fetch at a time. (default "10") + +**--depth** _int_ + +Set depth for your Child Workflow fetches. Pass -1 to fetch child workflows at any depth. (default "-1") + +**--fold** _string[]_ + +Fold away Child Workflows with the specified statuses. Case-insensitive. Ignored if --no-fold supplied. Available values: running, completed, failed, canceled, terminated, timedout, continueasnew. Can be passed multiple times. + +**--no-fold** _bool_ + +Disable folding. Fetch and display Child Workflows within the set depth. + +**--run-id**, **-r** _string_ + +Run ID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## update + +An Update is a synchronous call to a Workflow Execution that can change its +state, control its flow, and return a result. + +### describe + +Given a Workflow Execution and an Update ID, return information about its current status, including +a result if it has finished. + +``` +temporal workflow update describe \ + --workflow-id YourWorkflowId \ + --update-id YourUpdateId +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--run-id**, **-r** _string_ + +Run ID. If unset, updates the currently-running Workflow Execution. + +**--update-id** _string_ + +Update ID. Must be unique per Workflow Execution. Required. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### execute + +Send a message to a Workflow Execution to invoke an Update handler, and wait for +the update to complete or fail. You can also use this to wait for an existing +update to complete, by submitting an existing update ID. + +``` +temporal workflow update execute \ + --workflow-id YourWorkflowId \ + --name YourUpdate \ + --input '{"some-key": "some-value"}' +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--first-execution-run-id** _string_ + +Parent Run ID. The update is sent to the last Workflow Execution in the chain started with this Run ID. + +**--input**, **-i** _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** _bool_ + +Assume inputs are base64-encoded and attempt to decode them. + +**--input-file** _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** _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. + +**--name** _string_ + +Handler method name. Required. + +**--run-id**, **-r** _string_ + +Run ID. If unset, looks for an Update against the currently-running Workflow Execution. + +**--update-id** _string_ + +Update ID. If unset, defaults to a UUID. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### result + +Given a Workflow Execution and an Update ID, wait for the Update to complete or fail and +print the result. + +``` +temporal workflow update result \ + --workflow-id YourWorkflowId \ + --update-id YourUpdateId +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--run-id**, **-r** _string_ + +Run ID. If unset, updates the currently-running Workflow Execution. + +**--update-id** _string_ + +Update ID. Must be unique per Workflow Execution. Required. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +### start + +Send a message to a Workflow Execution to invoke an Update handler, and wait for +the update to be accepted or rejected. You can subsequently wait for the update +to complete by using `temporal workflow update execute`. + +``` +temporal workflow update start \ + --workflow-id YourWorkflowId \ + --name YourUpdate \ + --input '{"some-key": "some-value"}' + --wait-for-stage accepted +``` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--first-execution-run-id** _string_ + +Parent Run ID. The update is sent to the last Workflow Execution in the chain started with this Run ID. + +**--input**, **-i** _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** _bool_ + +Assume inputs are base64-encoded and attempt to decode them. + +**--input-file** _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** _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. + +**--name** _string_ + +Handler method name. Required. + +**--run-id**, **-r** _string_ + +Run ID. If unset, looks for an Update against the currently-running Workflow Execution. + +**--update-id** _string_ + +Update ID. If unset, defaults to a UUID. + +**--wait-for-stage** _string-enum_ + +Update stage to wait for. The only option is `accepted`, but this option is required. This is to allow a future version of the CLI to choose a default value. Required. Accepted values: accepted. + +**--workflow-id**, **-w** _string_ + +Workflow ID. Required. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + +## update-options + ++---------------------------------------------------------------------+ +| CAUTION: Worflow update-options is experimental. Workflow Execution | +| properties are subject to change. | ++---------------------------------------------------------------------+ + +Modify properties of Workflow Executions: + +``` +temporal workflow update-options [options] +``` + +It can override the Worker Deployment configuration of a +Workflow Execution, which controls Worker Versioning. + +For example, to force Workers in the current Deployment execute the +next Workflow Task change behavior to `auto_upgrade`: + +``` +temporal workflow update-options \ + --workflow-id YourWorkflowId \ + --versioning-override-behavior auto_upgrade +``` + +or to pin the workflow execution to a Worker Deployment, set behavior +to `pinned`: + +``` +temporal workflow update-options \ + --workflow-id YourWorkflowId \ + --versioning-override-behavior pinned \ + --versioning-override-deployment-name YourDeploymentName \ + --versioning-override-build-id YourDeploymentBuildId +``` + +To remove any previous overrides, set the behavior to +`unspecified`: + +``` +temporal workflow update-options \ + --workflow-id YourWorkflowId \ + --versioning-override-behavior unspecified +``` + +To see the current override use `temporal workflow describe` + +Use the following options to change the behavior of this command. + +**Flags:** + +**--query**, **-q** _string_ + +Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. + +**--reason** _string_ + +Reason for batch operation. Only use with --query. Defaults to user name. + +**--rps** _float_ + +Limit batch's requests per second. Only allowed if query is present. + +**--run-id**, **-r** _string_ + +Run ID. Only use with --workflow-id. Cannot use with --query. + +**--versioning-override-behavior** _string-enum_ + +Override the versioning behavior of a Workflow. Required. Accepted values: unspecified, pinned, auto_upgrade. + +**--versioning-override-build-id** _string_ + +When overriding to a `pinned` behavior, specifies the Build ID of the version to target. + +**--versioning-override-deployment-name** _string_ + +When overriding to a `pinned` behavior, specifies the Deployment Name of the version to target. + +**--workflow-id**, **-w** _string_ + +Workflow ID. You must set either --workflow-id or --query. + +**--yes**, **-y** _bool_ + +Don't prompt to confirm signaling. Only allowed when --query is present. + +**Global Flags:** + +**--address** _string_ + +Temporal Service gRPC endpoint. (default "127.0.0.1:7233") + +**--api-key** _string_ + +API key for request. + +**--client-connect-timeout** _duration_ + +The client connection timeout. 0s means no timeout. + +**--codec-auth** _string_ + +Authorization header for Codec Server requests. + +**--codec-endpoint** _string_ + +Remote Codec Server endpoint. + +**--codec-header** _string[]_ + +HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. + +**--color** _string-enum_ + +Output coloring. Accepted values: always, never, auto. (default "auto") + +**--command-timeout** _duration_ + +The command execution timeout. 0s means no timeout. + +**--config-file** _string_ + +File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. + +:::note + +Option is experimental. + +::: + +**--disable-config-env** _bool_ + +If set, disables loading environment config from environment variables. + +:::note + +Option is experimental. + +::: + +**--disable-config-file** _bool_ + +If set, disables loading environment config from config file. + +:::note + +Option is experimental. + +::: + +**--env** _string_ + +Active environment name (`ENV`). (default "default") + +**--env-file** _string_ + +Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. + +**--grpc-meta** _string[]_ + +HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. + +**--log-format** _string-enum_ + +Log format. Accepted values: text, json. (default "text") + +**--log-level** _string-enum_ + +Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") + +**--namespace**, **-n** _string_ + +Temporal Service Namespace. (default "default") + +**--no-json-shorthand-payloads** _bool_ + +Raw payload output, even if the JSON option was used. + +**--output**, **-o** _string-enum_ + +Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") + +**--profile** _string_ + +Profile to use for config file. + +:::note + +Option is experimental. + +::: + +**--time-format** _string-enum_ + +Time format. Accepted values: relative, iso, raw. (default "relative") + +**--tls** _bool_ + +Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. + +**--tls-ca-data** _string_ + +Data for server CA certificate. Can't be used with --tls-ca-path. + +**--tls-ca-path** _string_ + +Path to server CA certificate. Can't be used with --tls-ca-data. + +**--tls-cert-data** _string_ + +Data for x509 certificate. Can't be used with --tls-cert-path. + +**--tls-cert-path** _string_ + +Path to x509 certificate. Can't be used with --tls-cert-data. + +**--tls-disable-host-verification** _bool_ + +Disable TLS host-name verification. + +**--tls-key-data** _string_ + +Private certificate key data. Can't be used with --tls-key-path. + +**--tls-key-path** _string_ + +Path to x509 private key. Can't be used with --tls-key-data. + +**--tls-server-name** _string_ + +Override target TLS server name. + From eb43b04cdc8ba336528a8bf18abcceaf179224e0 Mon Sep 17 00:00:00 2001 From: Will Charczuk Date: Wed, 27 Aug 2025 12:26:36 -0700 Subject: [PATCH 03/10] revert these --- go.mod | 6 +++--- go.sum | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++------ 2 files changed, 63 insertions(+), 9 deletions(-) diff --git a/go.mod b/go.mod index 4d21c6701..f7d1f9238 100644 --- a/go.mod +++ b/go.mod @@ -16,7 +16,7 @@ require ( github.com/spf13/pflag v1.0.6 github.com/stretchr/testify v1.10.0 github.com/temporalio/ui-server/v2 v2.39.0 - go.temporal.io/api v1.51.0 + go.temporal.io/api v1.50.0 go.temporal.io/sdk v1.35.0 go.temporal.io/sdk/contrib/envconfig v0.1.0 go.temporal.io/server v1.28.0 @@ -27,7 +27,7 @@ require ( ) require ( - cel.dev/expr v0.23.1 // indirect + cel.dev/expr v0.22.1 // indirect cloud.google.com/go v0.120.0 // indirect cloud.google.com/go/auth v0.15.0 // indirect cloud.google.com/go/auth/oauth2adapt v0.2.8 // indirect @@ -76,7 +76,7 @@ require ( github.com/googleapis/gax-go/v2 v2.14.1 // indirect github.com/gorilla/mux v1.8.1 // indirect github.com/gorilla/securecookie v1.1.2 // indirect - github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.2 // indirect + github.com/grpc-ecosystem/go-grpc-middleware v1.4.0 // indirect github.com/grpc-ecosystem/grpc-gateway/v2 v2.26.3 // indirect github.com/hailocab/go-hostpool v0.0.0-20160125115350-e80d13ce29ed // indirect github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect diff --git a/go.sum b/go.sum index dd6225bee..a18e8152e 100644 --- a/go.sum +++ b/go.sum @@ -1,5 +1,6 @@ -cel.dev/expr v0.23.1 h1:K4KOtPCJQjVggkARsjG9RWXP6O4R73aHeJMa/dmCQQg= -cel.dev/expr v0.23.1/go.mod h1:hLPLo1W4QUmuYdA72RBX06QTs6MXw941piREPl3Yfiw= +cel.dev/expr v0.22.1 h1:xoFEsNh972Yzey8N9TCPx2nDvMN7TMhQEzxLuj/iRrI= +cel.dev/expr v0.22.1/go.mod h1:MrpN08Q+lEBs+bGYdLxxHkZoUSsCp0nSKTs0nTymJgw= +cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= cloud.google.com/go v0.120.0 h1:wc6bgG9DHyKqF5/vQvX1CiZrtHnxJjBlKUyF9nP6meA= cloud.google.com/go v0.120.0/go.mod h1:/beW32s8/pGRuj4IILWQNd4uuebeT4dkOhKmkfit64Q= cloud.google.com/go/auth v0.15.0 h1:Ly0u4aA5vG/fsSsxu98qCQBemXtAtJf+95z9HK+cxps= @@ -53,6 +54,7 @@ github.com/apache/thrift v0.21.0/go.mod h1:W1H8aR/QRtYNvrPeFXBtobyRkd0/YVhTc6i07 github.com/aws/aws-sdk-go v1.55.6 h1:cSg4pvZ3m8dgYcgqB97MrcdjUmZ1BeMYKUxMMB89IPk= github.com/aws/aws-sdk-go v1.55.6/go.mod h1:eRwEWoyTWFMVYVQzKMNHWP5/RV4xIUGMQfXQHfHkpNU= github.com/benbjohnson/clock v0.0.0-20160125162948-a620c1cc9866/go.mod h1:UMqtWQTnOe4byzwe7Zhwh8f8s+36uszN51sJrSIZlTE= +github.com/benbjohnson/clock v1.1.0/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA= github.com/benbjohnson/clock v1.3.5 h1:VvXlSJBzZpA/zum6Sj74hxwYI2DIxRWuNIoXAzHZz5o= github.com/benbjohnson/clock v1.3.5/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA= github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= @@ -73,8 +75,11 @@ github.com/cactus/go-statsd-client/v5 v5.1.0 h1:sbbdfIl9PgisjEoXzvXI1lwUKWElngsj github.com/cactus/go-statsd-client/v5 v5.1.0/go.mod h1:COEvJ1E+/E2L4q6QE5CkjWPi4eeDw9maJBMIuMPBZbY= github.com/cenkalti/backoff/v4 v4.3.0 h1:MyRJ/UdXutAwSAT+s3wNd7MfTIcy71VQueUuFK343L8= github.com/cenkalti/backoff/v4 v4.3.0/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE= +github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs= github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= +github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= +github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc= github.com/cncf/xds/go v0.0.0-20250326154945-ae57f3c0d45f h1:C5bqEmzEPLsHm9Mv73lSE9e9bKV23aB1vxOsmZrkl3k= github.com/cncf/xds/go v0.0.0-20250326154945-ae57f3c0d45f/go.mod h1:W+zGtBO5Y1IgJhy4+A9GOqVhqLpfZi+vwmdNXUehLA8= github.com/coreos/go-oidc/v3 v3.13.0 h1:M66zd0pcc5VxvBNM4pB331Wrsanby+QomQYjN8HamW8= @@ -93,12 +98,16 @@ github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkp github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto= github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= +github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= +github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98= github.com/envoyproxy/go-control-plane v0.13.4 h1:zEqyPVyku6IvWCFwux4x9RxkLOMUL+1vC9xUFv5l2/M= github.com/envoyproxy/go-control-plane v0.13.4/go.mod h1:kDfuBlDVsSj2MjrLEtRWtHlsWIFcGyB2RMO44Dc5GZA= github.com/envoyproxy/go-control-plane/envoy v1.32.4 h1:jb83lalDRZSpPWW2Z7Mck/8kXZ5CQAFYVjQcdVIr83A= github.com/envoyproxy/go-control-plane/envoy v1.32.4/go.mod h1:Gzjc5k8JcJswLjAx1Zm+wSYE20UrLtt7JZMWiWQXQEw= github.com/envoyproxy/go-control-plane/ratelimit v0.1.0 h1:/G9QYbddjL25KvtKTv3an9lx6VBE2cnb8wp1vEGNYGI= github.com/envoyproxy/go-control-plane/ratelimit v0.1.0/go.mod h1:Wk+tMFAFbCXaJPzVVHnPgRKdUdwW/KdbRt94AzgRee4= +github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= github.com/envoyproxy/protoc-gen-validate v1.2.1 h1:DEo3O99U8j4hBFwbJfrz9VtgcDfUKS7KJ7spH3d86P8= github.com/envoyproxy/protoc-gen-validate v1.2.1/go.mod h1:d/C80l/jxXLdfEIhX1W2TmLfsJ31lvEjwamM4DxlWXU= github.com/facebookgo/clock v0.0.0-20150410010913-600d898af40a h1:yDWHCSQ40h88yih2JAcL6Ls/kVkSE8GFACTGVnMPruw= @@ -117,6 +126,8 @@ github.com/go-faker/faker/v4 v4.6.0/go.mod h1:ZmrHuVtTTm2Em9e0Du6CJ9CADaLEzGXW62 github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU= github.com/go-jose/go-jose/v4 v4.0.5 h1:M6T8+mKZl/+fNNuFHvGIzDz7BTLQPIounk/b9dw3AaE= github.com/go-jose/go-jose/v4 v4.0.5/go.mod h1:s3P1lRrkT8igV8D9OjyL4WRyHvjB6a4JSllnOrmmBOA= +github.com/go-kit/log v0.1.0/go.mod h1:zbhenjAZHb184qTLMA9ZjW7ThYL0H2mk7Q6pNt4vbaY= +github.com/go-logfmt/logfmt v0.5.0/go.mod h1:wCYkCAKZfumFQihp8CzCvQ3paCTfi41vtzG1KdI/P7A= github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY= github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= @@ -125,6 +136,7 @@ github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre github.com/go-sql-driver/mysql v1.8.1/go.mod h1:wEBSXgmK//2ZFJyE+qWnIsVGmvmEKlqwuVSjsCm7DZg= github.com/go-sql-driver/mysql v1.9.1 h1:FrjNGn/BsJQjVRuSa8CBrM5BWA9BWoXXat3KrtSb/iI= github.com/go-sql-driver/mysql v1.9.1/go.mod h1:qn46aNg1333BRMNU69Lq93t8du/dwxI64Gl8i5p1WMU= +github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= github.com/gocql/gocql v1.7.0 h1:O+7U7/1gSN7QTEAaMEsJc1Oq2QHXvCWoF3DFK9HDHus= github.com/gocql/gocql v1.7.0/go.mod h1:vnlvXyFZeLBF0Wy+RS8hrOdbn0UWsWtdg07XJnFxZ+4= github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= @@ -132,9 +144,14 @@ github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69 github.com/golang-jwt/jwt/v4 v4.5.2 h1:YtQM7lnr8iZ+j5q71MGKkNw9Mn7AjHM68uc9g5fXeUI= github.com/golang-jwt/jwt/v4 v4.5.2/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0/go.mod h1:E/TSTwGwJL78qG/PmXZO1EjYhfJinVAhrmmHX6Z8B9k= +github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= +github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= github.com/golang/mock v1.5.0/go.mod h1:CWnOUgYIOo4TcNZ0wHX3YZCqsaM1I1Jvs6v3mP3KVu8= github.com/golang/mock v1.7.0-rc.1 h1:YojYx61/OLFsiv6Rw1Z96LpldJIy31o+UHmwAUMJ6/U= github.com/golang/mock v1.7.0-rc.1/go.mod h1:s42URUywIqd+OcERslBJvOjepvNymP31m3q8d/GkuRs= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.3/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw= github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek= github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps= github.com/golang/snappy v0.0.3/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= @@ -142,6 +159,7 @@ github.com/golang/snappy v1.0.0 h1:Oy607GVXHs7RtbggtPBnr2RmDArIsAefDwvrdWvRhGs= github.com/golang/snappy v1.0.0/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= github.com/gomarkdown/markdown v0.0.0-20250311123330-531bef5e742b h1:EY/KpStFl60qA17CptGXhwfZ+k1sFNJIUNR8DdbcuUk= github.com/gomarkdown/markdown v0.0.0-20250311123330-531bef5e742b/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA= +github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= @@ -165,8 +183,8 @@ github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY= github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ= github.com/gorilla/securecookie v1.1.2 h1:YCIWL56dvtr73r6715mJs5ZvhtnY73hBvEF8kXD8ePA= github.com/gorilla/securecookie v1.1.2/go.mod h1:NfCASbcHqRSY+3a8tlWJwsQap2VX5pwzwo4h3eOamfo= -github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.2 h1:sGm2vDRFUrQJO/Veii4h4zG2vvqG6uWNkBHSTqXOZk0= -github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.2/go.mod h1:wd1YpapPLivG6nQgbf7ZkG1hhSOXDhhn4MLTknx2aAc= +github.com/grpc-ecosystem/go-grpc-middleware v1.4.0 h1:UH//fgunKIs4JdUbpDl1VZCDaL56wXCB/5+wF6uHfaI= +github.com/grpc-ecosystem/go-grpc-middleware v1.4.0/go.mod h1:g5qyo/la0ALbONm6Vbp88Yd8NsDy6rZz+RcrMPxvld8= github.com/grpc-ecosystem/grpc-gateway/v2 v2.26.3 h1:5ZPtiqj0JL5oKWmcsq4VMaAW5ukBEgSGXEN89zeH1Jo= github.com/grpc-ecosystem/grpc-gateway/v2 v2.26.3/go.mod h1:ndYquD05frm2vACXE1nsccT4oJzjhw2arTS2cpUD1PI= github.com/hailocab/go-hostpool v0.0.0-20160125115350-e80d13ce29ed h1:5upAirOpQc1Q53c0bnx2ufif5kANL7bfZWcc6VJWJd8= @@ -264,6 +282,7 @@ github.com/prashantv/protectmem v0.0.0-20171002184600-e20412882b3a h1:AA9vgIBDjM github.com/prashantv/protectmem v0.0.0-20171002184600-e20412882b3a/go.mod h1:lzZQ3Noex5pfAy7mkAeCjcBDteYU85uWWnJ/y6gKU8k= github.com/prometheus/client_golang v1.21.1 h1:DOvXXTqVzvkIewV/CDPFdejpMCGeMcbGCQ8YOmu+Ibk= github.com/prometheus/client_golang v1.21.1/go.mod h1:U9NM32ykUErtVBxdvD3zfi+EuFkkaBvMb09mIfe0Zgg= +github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= github.com/prometheus/client_model v0.6.1 h1:ZKSh/rekM+n3CeS952MLRAdFwIKqeY8b62p8ais2e9E= github.com/prometheus/client_model v0.6.1/go.mod h1:OrxVMOVHjw3lKMa8+x6HeMGkHMQyHDk9E3jmP2AmGiY= github.com/prometheus/common v0.63.0 h1:YR/EIY1o3mEFP/kZCD7iDMnLPlGyuU2Gb3HIcXnA98k= @@ -371,8 +390,12 @@ go.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt go.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc= go.opentelemetry.io/proto/otlp v1.5.0 h1:xJvq7gMzB31/d406fB8U5CBdyQGw4P399D1aQWU/3i4= go.opentelemetry.io/proto/otlp v1.5.0/go.mod h1:keN8WnHxOy8PG0rQZjJJ5A2ebUoafqWp0eVQ4yIXvJ4= -go.temporal.io/api v1.51.0 h1:9+e14GrIa7nWoWoudqj/PSwm33yYjV+u8TAR9If7s/g= -go.temporal.io/api v1.51.0/go.mod h1:iaxoP/9OXMJcQkETTECfwYq4cw/bj4nwov8b3ZLVnXM= +go.temporal.io/api v1.50.0 h1:7s8Cn+fKfNx9G0v2Ge9We6X2WiCA3JvJ9JryeNbx1Bc= +go.temporal.io/api v1.50.0/go.mod h1:iaxoP/9OXMJcQkETTECfwYq4cw/bj4nwov8b3ZLVnXM= +go.temporal.io/sdk v1.35.0 h1:lRNAQ5As9rLgYa7HBvnmKyzxLcdElTuoFJ0FXM/AsLQ= +go.temporal.io/sdk v1.35.0/go.mod h1:1q5MuLc2MEJ4lneZTHJzpVebW2oZnyxoIOWX3oFVebw= +go.temporal.io/sdk/contrib/envconfig v0.1.0 h1:s+G/Ujph+Xl2jzLiiIm2T1vuijDkUL4Kse49dgDVGBE= +go.temporal.io/sdk/contrib/envconfig v0.1.0/go.mod h1:FQEO3C56h9C7M6sDgSanB8HnBTmopw9qgVx4F1S6pJk= go.temporal.io/server v1.28.0 h1:1rLPrT21ZwpsRjElJqSgThj1NZSAtAPyi8nKX+EAkgo= go.temporal.io/server v1.28.0/go.mod h1:yri8PdZoAtwI9p65hzvABf11WqXelHl/HabbrnJSu+g= go.temporal.io/version v0.3.0 h1:dMrei9l9NyHt8nG6EB8vAwDLLTwx2SvRyucCSumAiig= @@ -385,16 +408,19 @@ go.uber.org/dig v1.18.1 h1:rLww6NuajVjeQn+49u5NcezUJEGwd5uXmyoCKW2g5Es= go.uber.org/dig v1.18.1/go.mod h1:Us0rSJiThwCv2GteUN0Q7OKvU7n5J4dxZ9JKUXozFdE= go.uber.org/fx v1.23.0 h1:lIr/gYWQGfTwGcSXWXu4vP5Ws6iqnNEIY+F/aFzCKTg= go.uber.org/fx v1.23.0/go.mod h1:o/D9n+2mLP6v1EG+qsdT1O8wKopYAsqZasju97SDFCU= +go.uber.org/goleak v1.1.10/go.mod h1:8a7PlsEVH3e/a/GLqe5IIrQx6GzcnRmZEufDUTk4A7A= go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= go.uber.org/mock v0.5.0 h1:KAMbZvZPyBPWgD14IrIQ38QCyjwpvVVV6K/bHl1IwQU= go.uber.org/mock v0.5.0/go.mod h1:ge71pBPLYDk7QIi1LupWxdAykm7KIEFchiOqd6z7qMM= go.uber.org/multierr v1.3.0/go.mod h1:VgVr7evmIr6uPjLBxg28wmKNXyqE9akIJ5XnfpiKl+4= +go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU= go.uber.org/multierr v1.7.0/go.mod h1:7EAYxJLBy9rStEaz58O2t4Uvip6FSURkq8/ppBp95ak= go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee/go.mod h1:vJERXedbb3MVM5f9Ejo0C68/HhF8uaILCdgjnY+goOA= go.uber.org/zap v1.14.0/go.mod h1:zwrFLgMcdUuIBviXEYEH1YKNaOBnKXsx2IPda5bBwHM= +go.uber.org/zap v1.18.1/go.mod h1:xg/QME4nWcxGxrpdeYfq7UvYrLh66cuVKdrbD1XF/NI= go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8= go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= @@ -407,6 +433,7 @@ golang.org/x/crypto v0.38.0 h1:jt+WWG8IZlBnVbomuhg2Mdq0+BBQaHbtqHEFEigjUV8= golang.org/x/crypto v0.38.0/go.mod h1:MvrbAqul58NNYPKnOra203SB9vpuZW0e+RRZV+Ggqjw= golang.org/x/exp v0.0.0-20180321215751-8460e604b9de/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20180807140117-3d87b88a115f/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= +golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190125153040-c74c464bbbf2/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20191030013958-a1ab85dbe136/go.mod h1:JXzH8nQsPlswgeRAPE3MuO9GYsAcnJvJ4vnMwN/5qkY= @@ -415,6 +442,9 @@ golang.org/x/exp v0.0.0-20250305212735-054e65f0b394/go.mod h1:sIifuuw/Yco/y6yb6+ golang.org/x/image v0.0.0-20180708004352-c73c2afc3b81/go.mod h1:ux5Hcp/YLpHSI86hEcLt0YII63i6oz57MZXIpbrjZUs= golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js= golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= +golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= +golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= +golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= golang.org/x/mobile v0.0.0-20190719004257-d2bd2a29d028/go.mod h1:E/iHnbuqvinMTCcRqshq8CkpyQDoeVncDDYHnLhea+o= golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc= @@ -426,6 +456,9 @@ golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91 golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU= golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww= +golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= @@ -439,8 +472,11 @@ golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= golang.org/x/net v0.40.0 h1:79Xs7wF06Gbdcg4kdCCIQArK11Z1hr5POQ6+fIYHNuY= golang.org/x/net v0.40.0/go.mod h1:y0hY0exeL2Pku80/zKK7tpntoX23cqL3Oa6njdgRtds= +golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.30.0 h1:dnDm7JmhM45NNpd8FDDeLhK6FwqbOf4MLCM9zb1BOHI= golang.org/x/oauth2 v0.30.0/go.mod h1:B++QgG3ZKulg6sRPGD/mqlHQs5rB3Ml9erfeDY7xKlU= +golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -449,6 +485,7 @@ golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJ golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.14.0 h1:woo0S4Yywslg6hp4eUFjTVOyKt0RookbpAHG4c1HmhQ= golang.org/x/sync v0.14.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= +golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -460,6 +497,7 @@ golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20211019181941-9d821ace8654/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20211025201205-69cdffdb9359/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= @@ -487,12 +525,16 @@ golang.org/x/time v0.11.0 h1:/bpjEDfN9tkoN/ryeYHnv5hcMlc8ncjMcM4XBk5NWV0= golang.org/x/time v0.11.0/go.mod h1:CDIdPxbZBQxdj6cxyCIdrNogrJKMJ7pr37NYpMcMDSg= golang.org/x/tools v0.0.0-20180525024113-a5b4c53f6e8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190206041539-40960b6deb8e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY= golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20191012152004-8de300cfc20a/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191108193012-7d206e10da11/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= @@ -511,12 +553,22 @@ gonum.org/v1/netlib v0.0.0-20190313105609-8cb42192e0e0/go.mod h1:wa6Ws7BG/ESfp6d gonum.org/v1/plot v0.0.0-20190515093506-e2840ee46a6b/go.mod h1:Wt8AAjI+ypCyYX3nZBvf6cAIx93T+c/OS2HFAYskSZc= google.golang.org/api v0.228.0 h1:X2DJ/uoWGnY5obVjewbp8icSL5U4FzuCfy9OjbLSnLs= google.golang.org/api v0.228.0/go.mod h1:wNvRS1Pbe8r4+IfBIniV8fwCpGwTrYa+kMUDiC5z5a4= +google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= +google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= +google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc= +google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc= +google.golang.org/genproto v0.0.0-20200423170343-7949de9c1215/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/genproto v0.0.0-20250324211829-b45e905df463 h1:qEFnJI6AnfZk0NNe8YTyXQh5i//Zxi4gBHwRgp76qpw= google.golang.org/genproto v0.0.0-20250324211829-b45e905df463/go.mod h1:SqIx1NV9hcvqdLHo7uNZDS5lrUJybQ3evo3+z/WBfA0= google.golang.org/genproto/googleapis/api v0.0.0-20250324211829-b45e905df463 h1:hE3bRWtU6uceqlh4fhrSnUyjKHMKB9KrTLLG+bc0ddM= google.golang.org/genproto/googleapis/api v0.0.0-20250324211829-b45e905df463/go.mod h1:U90ffi8eUL9MwPcrJylN5+Mk2v3vuPDptd5yyNUiRR8= google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463 h1:e0AIkUUhxyBKh6ssZNrAMeqhA7RKUj42346d1y02i2g= google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A= +google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= +google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg= +google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY= +google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk= +google.golang.org/grpc v1.29.1/go.mod h1:itym6AZVZYACWQqET3MqgPpjcuV5QH3BxFS3IjizoKk= google.golang.org/grpc v1.71.0 h1:kF77BGdPTQ4/JZWMlb9VpJ5pa25aqvVqogsxNHHdeBg= google.golang.org/grpc v1.71.0/go.mod h1:H0GRtasmQOh9LkFoCPDu3ZrwUtD1YGE+b2vYBYd/8Ec= google.golang.org/protobuf v1.36.6 h1:z1NpPI8ku2WgiWnf+t9wTPsn6eP1L7ksHUlkfLvd9xY= @@ -539,6 +591,8 @@ gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg= modernc.org/cc/v4 v4.25.2 h1:T2oH7sZdGvTaie0BRNFbIYsabzCxUQg8nLqCdQ2i0ic= modernc.org/cc/v4 v4.25.2/go.mod h1:uVtb5OGqUKpoLWhqwNQo/8LwvoiEBLvZXIQ/SmO6mL0= From 44cbb8a95b77be075ad786ace96bf1d6cb4e21f3 Mon Sep 17 00:00:00 2001 From: Will Charczuk Date: Wed, 27 Aug 2025 12:27:17 -0700 Subject: [PATCH 04/10] revert this --- temporalcli/commands.config.go | 1 - 1 file changed, 1 deletion(-) diff --git a/temporalcli/commands.config.go b/temporalcli/commands.config.go index 7319dd218..a4028ff46 100644 --- a/temporalcli/commands.config.go +++ b/temporalcli/commands.config.go @@ -251,7 +251,6 @@ func loadEnvConfigProfile( var envConfigPropsToFieldNames = map[string]string{ "address": "Address", - "grpc_authority": "GRPCAuthority", "namespace": "Namespace", "api_key": "APIKey", "tls": "TLS", From 4008588979f2e43b3cba237624a826c77e11f008 Mon Sep 17 00:00:00 2001 From: Will Charczuk Date: Wed, 27 Aug 2025 12:27:39 -0700 Subject: [PATCH 05/10] updates --- temporalcli/docs/activity.mdx | 24 ++++++++ temporalcli/docs/batch.mdx | 12 ++++ temporalcli/docs/config.mdx | 20 +++++++ temporalcli/docs/env.mdx | 16 +++++ temporalcli/docs/operator.mdx | 76 ++++++++++++++++++++++++ temporalcli/docs/schedule.mdx | 32 ++++++++++ temporalcli/docs/server.mdx | 4 ++ temporalcli/docs/task-queue.mdx | 64 ++++++++++++++++++++ temporalcli/docs/worker.mdx | 32 ++++++++++ temporalcli/docs/workflow.mdx | 100 ++++++++++++++++++++++++++++++++ 10 files changed, 380 insertions(+) diff --git a/temporalcli/docs/activity.mdx b/temporalcli/docs/activity.mdx index 6254e9b88..cd0f21971 100644 --- a/temporalcli/docs/activity.mdx +++ b/temporalcli/docs/activity.mdx @@ -132,6 +132,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -317,6 +321,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -513,6 +521,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -732,6 +744,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -971,6 +987,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1198,6 +1218,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. diff --git a/temporalcli/docs/batch.mdx b/temporalcli/docs/batch.mdx index e615bdaed..78a5b8ae0 100644 --- a/temporalcli/docs/batch.mdx +++ b/temporalcli/docs/batch.mdx @@ -109,6 +109,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -273,6 +277,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -443,6 +451,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. diff --git a/temporalcli/docs/config.mdx b/temporalcli/docs/config.mdx index 703afeb01..71c97e8af 100644 --- a/temporalcli/docs/config.mdx +++ b/temporalcli/docs/config.mdx @@ -110,6 +110,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -267,6 +271,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -436,6 +444,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -592,6 +604,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -760,6 +776,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. diff --git a/temporalcli/docs/env.mdx b/temporalcli/docs/env.mdx index a2adf7cd0..72c35d911 100644 --- a/temporalcli/docs/env.mdx +++ b/temporalcli/docs/env.mdx @@ -120,6 +120,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -295,6 +299,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -448,6 +456,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -625,6 +637,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. diff --git a/temporalcli/docs/operator.mdx b/temporalcli/docs/operator.mdx index 84551d49e..5c67b9d64 100644 --- a/temporalcli/docs/operator.mdx +++ b/temporalcli/docs/operator.mdx @@ -142,6 +142,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -298,6 +302,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -462,6 +470,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -625,6 +637,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -787,6 +803,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -961,6 +981,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1201,6 +1225,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1370,6 +1398,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1540,6 +1572,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1696,6 +1732,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1928,6 +1968,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2148,6 +2192,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2310,6 +2358,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2472,6 +2524,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2628,6 +2684,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2840,6 +2900,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -3025,6 +3089,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -3182,6 +3250,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -3358,6 +3430,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. diff --git a/temporalcli/docs/schedule.mdx b/temporalcli/docs/schedule.mdx index d47851a12..80670c5cc 100644 --- a/temporalcli/docs/schedule.mdx +++ b/temporalcli/docs/schedule.mdx @@ -157,6 +157,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -465,6 +469,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -632,6 +640,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -796,6 +808,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -967,6 +983,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1157,6 +1177,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1324,6 +1348,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1617,6 +1645,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. diff --git a/temporalcli/docs/server.mdx b/temporalcli/docs/server.mdx index 9588a212f..012183b8e 100644 --- a/temporalcli/docs/server.mdx +++ b/temporalcli/docs/server.mdx @@ -197,6 +197,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. diff --git a/temporalcli/docs/task-queue.mdx b/temporalcli/docs/task-queue.mdx index 9abfcc858..2eb92a14b 100644 --- a/temporalcli/docs/task-queue.mdx +++ b/temporalcli/docs/task-queue.mdx @@ -215,6 +215,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -396,6 +400,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -570,6 +578,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -733,6 +745,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -930,6 +946,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1110,6 +1130,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1289,6 +1313,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1469,6 +1497,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1672,6 +1704,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1861,6 +1897,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2042,6 +2082,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2214,6 +2258,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2386,6 +2434,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2570,6 +2622,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2772,6 +2828,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2950,6 +3010,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. diff --git a/temporalcli/docs/worker.mdx b/temporalcli/docs/worker.mdx index bf9f0ce68..d929c81b8 100644 --- a/temporalcli/docs/worker.mdx +++ b/temporalcli/docs/worker.mdx @@ -153,6 +153,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -348,6 +352,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -525,6 +533,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -708,6 +720,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -876,6 +892,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1088,6 +1108,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1316,6 +1340,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1505,6 +1533,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. diff --git a/temporalcli/docs/workflow.mdx b/temporalcli/docs/workflow.mdx index f1c093fb4..99e6b683c 100644 --- a/temporalcli/docs/workflow.mdx +++ b/temporalcli/docs/workflow.mdx @@ -169,6 +169,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -336,6 +340,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -525,6 +533,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -708,6 +720,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -968,6 +984,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1257,6 +1277,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1425,6 +1449,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1617,6 +1645,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1789,6 +1821,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -1985,6 +2021,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2177,6 +2217,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2344,6 +2388,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2522,6 +2570,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -2732,6 +2784,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -3006,6 +3062,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -3179,6 +3239,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -3429,6 +3493,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -3723,6 +3791,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -3925,6 +3997,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -4109,6 +4185,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -4287,6 +4367,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -4486,6 +4570,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -4659,6 +4747,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -4863,6 +4955,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. @@ -5096,6 +5192,10 @@ Active environment name (`ENV`). (default "default") Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. +**--grpc-authority** _string_ + +Temporal gRPC client :authority pseudoheader. + **--grpc-meta** _string[]_ HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. From 493ecf0767e355d76b36ad14695666a671a523d3 Mon Sep 17 00:00:00 2001 From: wcharczuk-stripe Date: Wed, 27 Aug 2025 12:37:50 -0700 Subject: [PATCH 06/10] Update temporalcli/client.go Co-authored-by: Chad Retz --- temporalcli/client.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/temporalcli/client.go b/temporalcli/client.go index ff4b03087..ba4985746 100644 --- a/temporalcli/client.go +++ b/temporalcli/client.go @@ -174,7 +174,7 @@ func (c *ClientOptions) dialClient(cctx *CommandContext) (client.Client, error) return nil, fmt.Errorf("failed creating client options: %w", err) } - if grpcAuthorityExplicitlySet { + if c.GrpcAuthority != "" { clientOptions.ConnectionOptions.Authority = c.GrpcAuthority } From ca0895380f039758134e3ea2531510a5c152bd76 Mon Sep 17 00:00:00 2001 From: wcharczuk-stripe Date: Wed, 27 Aug 2025 12:38:10 -0700 Subject: [PATCH 07/10] Update temporalcli/commandsgen/commands.yml Co-authored-by: Chad Retz --- temporalcli/commandsgen/commands.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/temporalcli/commandsgen/commands.yml b/temporalcli/commandsgen/commands.yml index 23b942aa7..9eb3ea9c9 100644 --- a/temporalcli/commandsgen/commands.yml +++ b/temporalcli/commandsgen/commands.yml @@ -4054,7 +4054,6 @@ option-sets: - name: grpc-authority type: string description: Temporal gRPC client :authority pseudoheader. - implied-env: TEMPORAL_GRPC_AUTHORITY - name: namespace short: n type: string From 4afcc2970feb6dc7733519845d5240228e3a612e Mon Sep 17 00:00:00 2001 From: Will Charczuk Date: Wed, 27 Aug 2025 12:55:18 -0700 Subject: [PATCH 08/10] reflecting change --- temporalcli/client.go | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/temporalcli/client.go b/temporalcli/client.go index ba4985746..5d7b14641 100644 --- a/temporalcli/client.go +++ b/temporalcli/client.go @@ -82,10 +82,9 @@ func (c *ClientOptions) dialClient(cctx *CommandContext) (client.Client, error) // Override some values in client config profile that come from CLI args. Some // flags, like address and namespace, have CLI defaults, but we don't want to // override the profile version unless it was _explicitly_ set. - var addressExplicitlySet, grpcAuthorityExplicitlySet, namespaceExplicitlySet bool + var addressExplicitlySet, namespaceExplicitlySet bool if cctx.CurrentCommand != nil { addressExplicitlySet = cctx.CurrentCommand.Flags().Changed("address") - grpcAuthorityExplicitlySet = cctx.CurrentCommand.Flags().Changed("grpc-authority") namespaceExplicitlySet = cctx.CurrentCommand.Flags().Changed("namespace") } if addressExplicitlySet { From 12cfd5bb283e3e289ffac3eb63df066a0e840f94 Mon Sep 17 00:00:00 2001 From: Will Charczuk Date: Wed, 27 Aug 2025 13:18:00 -0700 Subject: [PATCH 09/10] removing docs --- temporalcli/docs/activity.mdx | 1298 -------- temporalcli/docs/batch.mdx | 531 ---- temporalcli/docs/config.mdx | 856 ----- temporalcli/docs/env.mdx | 717 ----- temporalcli/docs/operator.mdx | 3510 -------------------- temporalcli/docs/schedule.mdx | 1725 ---------- temporalcli/docs/server.mdx | 277 -- temporalcli/docs/task-queue.mdx | 3090 ------------------ temporalcli/docs/worker.mdx | 1613 ---------- temporalcli/docs/workflow.mdx | 5272 ------------------------------- 10 files changed, 18889 deletions(-) delete mode 100644 temporalcli/docs/activity.mdx delete mode 100644 temporalcli/docs/batch.mdx delete mode 100644 temporalcli/docs/config.mdx delete mode 100644 temporalcli/docs/env.mdx delete mode 100644 temporalcli/docs/operator.mdx delete mode 100644 temporalcli/docs/schedule.mdx delete mode 100644 temporalcli/docs/server.mdx delete mode 100644 temporalcli/docs/task-queue.mdx delete mode 100644 temporalcli/docs/worker.mdx delete mode 100644 temporalcli/docs/workflow.mdx diff --git a/temporalcli/docs/activity.mdx b/temporalcli/docs/activity.mdx deleted file mode 100644 index cd0f21971..000000000 --- a/temporalcli/docs/activity.mdx +++ /dev/null @@ -1,1298 +0,0 @@ -{/* 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 */} ---- -id: activity -title: Temporal CLI activity command reference -sidebar_label: activity -description: Learn how to use Temporal Activity commands for completing or failing Activity Executions in your Workflow. Optimize your Temporal Workflow management effectively. -toc_max_heading_level: 4 -keywords: - - activity - - activity complete - - activity update-options - - activity pause - - activity unpause - - activity reset - - activity execution - - activity fail - - cli reference - - cli-feature - - command-line-interface-cli - - temporal cli -tags: - - Activities - - Temporal CLI ---- - -## complete - -Complete an Activity, marking it as successfully finished. Specify the -Activity ID and include a JSON result for the returned value: - -``` -temporal activity complete \ - --activity-id YourActivityId \ - --workflow-id YourWorkflowId \ - --result '{"YourResultKey": "YourResultVal"}' -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--activity-id** _string_ - -Activity ID to complete. Required. - -**--identity** _string_ - -Identity of the user submitting this request. - -**--result** _string_ - -Result `JSON` to return. Required. - -**--run-id**, **-r** _string_ - -Run ID. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## fail - -Fail an Activity, marking it as having encountered an error. Specify the -Activity and Workflow IDs: - -``` -temporal activity fail \ - --activity-id YourActivityId \ - --workflow-id YourWorkflowId -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--activity-id** _string_ - -Activity ID to fail. Required. - -**--detail** _string_ - -Reason for failing the Activity (JSON). - -**--identity** _string_ - -Identity of the user submitting this request. - -**--reason** _string_ - -Reason for failing the Activity. - -**--run-id**, **-r** _string_ - -Run ID. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## pause - -Pause an Activity. - -If the Activity is not currently running (e.g. because it previously -failed), it will not be run again until it is unpaused. - -However, if the Activity is currently running, it will run until the next -time it fails, completes, or times out, at which point the pause will kick in. - -If the Activity is on its last retry attempt and fails, the failure will -be returned to the caller, just as if the Activity had not been paused. - -Activities should be specified either by their Activity ID or Activity Type. - -For example, specify the Activity and Workflow IDs like this: - -``` -temporal activity pause \ - --activity-id YourActivityId \ - --workflow-id YourWorkflowId -``` - -To later unpause the activity, see [unpause](#unpause). You may also want to -[reset](#reset) the activity to unpause it while also starting it from the beginning. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--activity-id**, **-a** _string_ - -The Activity ID to pause. Either `activity-id` or `activity-type` must be provided, but not both. - -**--activity-type**, **-g** _string_ - -All activities of the Activity Type will be paused. Either `activity-id` or `activity-type` must be provided, but not both. - -**--identity** _string_ - -The identity of the user or client submitting this request. - -**--run-id**, **-r** _string_ - -Run ID. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## reset - -Reset an activity. This restarts the activity as if it were first being -scheduled. That is, it will reset both the number of attempts and the -activity timeout, as well as, optionally, the -[heartbeat details](#reset-heartbeats). - -If the activity may be executing (i.e. it has not yet timed out), the -reset will take effect the next time it fails, heartbeats, or times out. -If is waiting for a retry (i.e. has failed or timed out), the reset -will apply immediately. - -If the activity is already paused, it will be unpaused by default. -You can specify `keep_paused` to prevent this. - -If the activity is paused and the `keep_paused` flag is not provided, -it will be unpaused. If the activity is paused and `keep_paused` flag -is provided - it will stay paused. - -Activities can be specified by their Activity ID or Activity Type. - -### Resetting activities that heartbeat {#reset-heartbeats} - -Activities that heartbeat will receive a [Canceled failure](/references/failures#cancelled-failure) -the next time they heartbeat after a reset. - -If, in your Activity, you need to do any cleanup when an Activity is -reset, handle this error and then re-throw it when you've cleaned up. - -If the `reset_heartbeats` flag is set, the heartbeat details will also be cleared. - -Specify the Activity Type of ID and Workflow IDs: - -``` -temporal activity reset \ - --activity-id YourActivityId \ - --workflow-id YourWorkflowId - --keep-paused - --reset-heartbeats -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--activity-id**, **-a** _string_ - -The Activity ID to reset. Either `activity-id` or `activity-type` must be provided, but not both. - -**--activity-type**, **-g** _string_ - -The Activity Type to reset. Either `activity-id` or `activity-type` must be provided, but not both. - -**--identity** _string_ - -The identity of the user or client submitting this request. - -**--keep-paused** _bool_ - -If the activity was paused, it will stay paused. - -**--reset-heartbeats** _bool_ - -Clear the Activity's heartbeat details. - -**--run-id**, **-r** _string_ - -Run ID. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## unpause - -Re-schedule a previously-paused Activity for execution. - -If the Activity is not running and is past its retry timeout, it will be -scheduled immediately. Otherwise, it will be scheduled after its retry -timeout expires. - -Use `--reset-attempts` to reset the number of previous run attempts to -zero. For example, if an Activity is near the maximum number of attempts -N specified in its retry policy, `--reset-attempts` will allow the -Activity to be retried another N times after unpausing. - -Use `--reset-heartbeat` to reset the Activity's heartbeats. - -Activities can be specified by their Activity ID or Activity Type. -One of those parameters must be provided. - -Specify the Activity ID or Type and Workflow IDs: - -``` -temporal activity unpause \ - --activity-id YourActivityId \ - --workflow-id YourWorkflowId - --reset-attempts - --reset-heartbeats -``` - -Activities can be unpaused in bulk via a visibility Query list filter. -For example, if you want to unpause activities of type Foo that you -previously paused, do: - -``` -temporal activity unpause \ - --query 'TemporalPauseInfo="property:activityType=Foo"' -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--activity-id**, **-a** _string_ - -The Activity ID to unpause. Can only be used without --query or --match-all. Either `activity-id` or `activity-type` must be provided, but not both. - -**--activity-type**, **-g** _string_ - -Activities of this Type will unpause. Can only be used without --match-all. Either `activity-id` or `activity-type` must be provided, but not both. - -**--identity** _string_ - -The identity of the user or client submitting this request. - -**--jitter**, **-j** _duration_ - -The activity will start at random a time within the specified duration. Can only be used with --query. - -**--match-all** _bool_ - -Every paused activity should be unpaused. This flag is ignored if activity-type is provided. Can only be used with --query. - -**--query**, **-q** _string_ - -Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. - -**--reason** _string_ - -Reason for batch operation. Only use with --query. Defaults to user name. - -**--reset-attempts** _bool_ - -Also reset the activity attempts. - -**--reset-heartbeats** _bool_ - -Reset the Activity's heartbeats. Only works with --reset-attempts. - -**--rps** _float_ - -Limit batch's requests per second. Only allowed if query is present. - -**--run-id**, **-r** _string_ - -Run ID. Only use with --workflow-id. Cannot use with --query. - -**--workflow-id**, **-w** _string_ - -Workflow ID. You must set either --workflow-id or --query. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm signaling. Only allowed when --query is present. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## update-options - -Update the options of a running Activity that were passed into it from - a Workflow. Updates are incremental, only changing the specified - options. - -For example: - -``` -temporal activity update-options \ - --activity-id YourActivityId \ - --workflow-id YourWorkflowId \ - --task-queue NewTaskQueueName \ - --schedule-to-close-timeout DURATION \ - --schedule-to-start-timeout DURATION \ - --start-to-close-timeout DURATION \ - --heartbeat-timeout DURATION \ - --retry-initial-interval DURATION \ - --retry-maximum-interval DURATION \ - --retry-backoff-coefficient NewBackoffCoefficient \ - --retry-maximum-attempts NewMaximumAttempts -``` - -You may follow this command with `temporal activity reset`, and the new values will apply after the reset. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--activity-id** _string_ - -Activity ID. Required. - -**--heartbeat-timeout** _duration_ - -Maximum permitted time between successful worker heartbeats. - -**--identity** _string_ - -Identity of the user submitting this request. - -**--retry-backoff-coefficient** _float_ - -Coefficient used to calculate the next retry interval. The next retry interval is previous interval multiplied by the backoff coefficient. Must be 1 or larger. - -**--retry-initial-interval** _duration_ - -Interval of the first retry. If retryBackoffCoefficient is 1.0 then it is used for all retries. - -**--retry-maximum-attempts** _int_ - -Maximum number of attempts. When exceeded the retries stop even if not expired yet. Setting this value to 1 disables retries. Setting this value to 0 means unlimited attempts(up to the timeouts). - -**--retry-maximum-interval** _duration_ - -Maximum interval between retries. Exponential backoff leads to interval increase. This value is the cap of the increase. - -**--run-id**, **-r** _string_ - -Run ID. - -**--schedule-to-close-timeout** _duration_ - -Indicates how long the caller is willing to wait for an activity completion. Limits how long retries will be attempted. - -**--schedule-to-start-timeout** _duration_ - -Limits time an activity task can stay in a task queue before a worker picks it up. This timeout is always non retryable, as all a retry would achieve is to put it back into the same queue. Defaults to the schedule-to-close timeout or workflow execution timeout if not specified. - -**--start-to-close-timeout** _duration_ - -Maximum time an activity is allowed to execute after being picked up by a worker. This timeout is always retryable. - -**--task-queue** _string_ - -Name of the task queue for the Activity. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - diff --git a/temporalcli/docs/batch.mdx b/temporalcli/docs/batch.mdx deleted file mode 100644 index 78a5b8ae0..000000000 --- a/temporalcli/docs/batch.mdx +++ /dev/null @@ -1,531 +0,0 @@ -{/* 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 */} ---- -id: batch -title: Temporal CLI batch command reference -sidebar_label: batch -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. -toc_max_heading_level: 4 -keywords: - - batch - - batch describe - - batch list - - batch terminate - - cli reference - - cli-feature - - command-line-interface-cli - - temporal cli -tags: - - Temporal CLI ---- - -## describe - -Show the progress of an ongoing batch job. Pass a valid job ID to display its -information: - -``` -temporal batch describe \ - --job-id YourJobId -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--job-id** _string_ - -Batch job ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## list - -Return a list of batch jobs on the Service or within a single Namespace. For -example, list the batch jobs for "YourNamespace": - -``` -temporal batch list \ - --namespace YourNamespace -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--limit** _int_ - -Maximum number of batch jobs to display. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## terminate - -Terminate a batch job with the provided job ID. You must provide a reason for -the termination. The Service stores this explanation as metadata for the -termination event for later reference: - -``` -temporal batch terminate \ - --job-id YourJobId \ - --reason YourTerminationReason -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--job-id** _string_ - -Job ID to terminate. Required. - -**--reason** _string_ - -Reason for terminating the batch job. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - diff --git a/temporalcli/docs/config.mdx b/temporalcli/docs/config.mdx deleted file mode 100644 index 71c97e8af..000000000 --- a/temporalcli/docs/config.mdx +++ /dev/null @@ -1,856 +0,0 @@ -{/* 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 */} ---- -id: config -title: Temporal CLI config command reference -sidebar_label: config -description: Temporal CLI 'config' commands allow the getting, setting, deleting, and listing of configuration properties for connecting to Temporal. -toc_max_heading_level: 4 -keywords: - - cli reference - - command-line-interface-cli - - configuration - - config - - config delete - - config get - - config list - - config set - - environment - - temporal cli -tags: - - Temporal CLI ---- - -## delete - -Remove a property within a profile. - -``` -temporal env delete \ - --prop tls.client_cert_path -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--prop**, **-p** _string_ - -Specific property to delete. If unset, deletes entire profile. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## delete-profile - -Remove a full profile entirely. The `--profile` must be set explicitly. - -``` -temporal env delete-profile \ - --profile my-profile -``` - -Use the following options to change the behavior of this command. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## get - -Display specific properties or the entire profile. - -``` -temporal config get \ - --prop address -``` - -or - -``` -temporal config get -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--prop**, **-p** _string_ - -Specific property to get. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## list - -List profile names in the config file. - -``` -temporal config list -``` - -Use the following options to change the behavior of this command. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## set - -Assign a value to a property and store it in the config file: - -``` -temporal config set \ - --prop address \ - --value us-west-2.aws.api.temporal.io:7233 -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--prop**, **-p** _string_ - -Property name. Required. - -**--value**, **-v** _string_ - -Property value. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - diff --git a/temporalcli/docs/env.mdx b/temporalcli/docs/env.mdx deleted file mode 100644 index 72c35d911..000000000 --- a/temporalcli/docs/env.mdx +++ /dev/null @@ -1,717 +0,0 @@ -{/* 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 */} ---- -id: env -title: Temporal CLI env command reference -sidebar_label: env -description: Temporal CLI 'env' commands allow the configuration, setting, deleting, and listing of environmental properties, making it easy to manage Temporal Server instances. -toc_max_heading_level: 4 -keywords: - - cli reference - - command-line-interface-cli - - configuration - - env - - env delete - - env get - - env list - - env set - - environment - - temporal cli -tags: - - Temporal CLI ---- - -## delete - -Remove a presets environment entirely _or_ remove a key-value pair within an -environment. If you don't specify an environment (with `--env` or by setting -the `TEMPORAL_ENV` variable), this command updates the "default" environment: - -``` -temporal env delete \ - --env YourEnvironment -``` - -or - -``` -temporal env delete \ - --env prod \ - --key tls-key-path -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--key**, **-k** _string_ - -Property name. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## get - -List the properties for a given environment: - -``` -temporal env get \ - --env YourEnvironment -``` - -Print a single property: - -``` -temporal env get \ - --env YourEnvironment \ - --key YourPropertyKey -``` - -If you don't specify an environment (with `--env` or by setting the -`TEMPORAL_ENV` variable), this command lists properties of the "default" -environment. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--key**, **-k** _string_ - -Property name. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## list - -List the environments you have set up on your local computer. Environments are -stored in "$HOME/.config/temporalio/temporal.yaml". - -Use the following options to change the behavior of this command. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## set - -Assign a value to a property key and store it to an environment: - -``` -temporal env set \ - --env environment \ - --key property \ - --value value -``` - -If you don't specify an environment (with `--env` or by setting the -`TEMPORAL_ENV` variable), this command sets properties in the "default" -environment. - -Storing keys with CLI option names lets the CLI automatically set those -options for you. This reduces effort and helps avoid typos when issuing -commands. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--key**, **-k** _string_ - -Property name (required). - -**--value**, **-v** _string_ - -Property value (required). - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - diff --git a/temporalcli/docs/operator.mdx b/temporalcli/docs/operator.mdx deleted file mode 100644 index 5c67b9d64..000000000 --- a/temporalcli/docs/operator.mdx +++ /dev/null @@ -1,3510 +0,0 @@ -{/* 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 */} ---- -id: operator -title: Temporal CLI operator command reference -sidebar_label: operator -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]". -toc_max_heading_level: 4 -keywords: - - cli reference - - cluster - - cluster health - - cluster list - - cluster remove - - cluster upsert - - command-line-interface-cli - - describe - - namespace - - namespace create - - namespace delete - - namespace describe - - namespace list - - nexus - - nexus endpoint - - nexus endpoint create - - nexus endpoint delete - - nexus endpoint get - - nexus endpoint list - - nexus endpoint update - - operator - - search attribute - - search attribute create - - search attribute list - - search attribute remove - - system - - temporal cli - - update -tags: - - Temporal CLI ---- - -## cluster - -Perform operator actions on Temporal Services (also known as Clusters). - -``` -temporal operator cluster [subcommand] [options] -``` - -For example to check Service/Cluster health: - -``` -temporal operator cluster health -``` - -### describe - -View information about a Temporal Cluster (Service), including Cluster Name, -persistence store, and visibility store. Add `--detail` for additional info: - -``` -temporal operator cluster describe [--detail] -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--detail** _bool_ - -Show history shard count and Cluster/Service version information. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### health - -View information about the health of a Temporal Service: - -``` -temporal operator cluster health -``` - -Use the following options to change the behavior of this command. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### list - -Print a list of remote Temporal Clusters (Services) registered to the local -Service. Report details include the Cluster's name, ID, address, History Shard -count, Failover version, and availability: - -``` -temporal operator cluster list [--limit max-count] -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--limit** _int_ - -Maximum number of Clusters to display. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### remove - -Remove a registered remote Temporal Cluster (Service) from the local Service. - -``` -temporal operator cluster remove \ - --name YourClusterName -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--name** _string_ - -Cluster/Service name. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### system - -Show Temporal Server information for Temporal Clusters (Service): Server -version, scheduling support, and more. This information helps diagnose -problems with the Temporal Server. - -The command defaults to the local Service. Otherwise, use the -`--frontend-address` option to specify a Cluster (Service) endpoint: - -``` -temporal operator cluster system \ - --frontend-address "YourRemoteEndpoint:YourRemotePort" -``` - -Use the following options to change the behavior of this command. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### upsert - -Add, remove, or update a registered ("remote") Temporal Cluster (Service). - -``` -temporal operator cluster upsert [options] -``` - -For example: - -``` -temporal operator cluster upsert \ - --frontend-address "YourRemoteEndpoint:YourRemotePort" - --enable-connection false -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--enable-connection** _bool_ - -Set the connection to "enabled". - -**--frontend-address** _string_ - -Remote endpoint. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## namespace - -Manage Temporal Cluster (Service) Namespaces: - -``` -temporal operator namespace [command] [command options] -``` - -For example: - -``` -temporal operator namespace create \ - --namespace YourNewNamespaceName -``` - -### create - -Create a new Namespace on the Temporal Service: - -``` -temporal operator namespace create \ - --namespace YourNewNamespaceName \ - [options] -```` - -Create a Namespace with multi-region data replication: - -``` -temporal operator namespace create \ - --global \ - --namespace YourNewNamespaceName -``` - -Configure settings like retention and Visibility Archival State as needed. -For example, the Visibility Archive can be set on a separate URI: - -``` -temporal operator namespace create \ - --retention 5d \ - --visibility-archival-state enabled \ - --visibility-uri YourURI \ - --namespace YourNewNamespaceName -``` - -Note: URI values for archival states can't be changed once enabled. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--active-cluster** _string_ - -Active Cluster (Service) name. - -**--cluster** _string[]_ - -Cluster (Service) names for Namespace creation. Can be passed multiple times. - -**--data** _string[]_ - -Namespace data as `KEY=VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. - -**--description** _string_ - -Namespace description. - -**--email** _string_ - -Owner email. - -**--global** _bool_ - -Enable multi-region data replication. - -**--history-archival-state** _string-enum_ - -History archival state. Accepted values: disabled, enabled. (default "disabled") - -**--history-uri** _string_ - -Archive history to this `URI`. Once enabled, can't be changed. - -**--retention** _duration_ - -Time to preserve closed Workflows before deletion. (default "72h") - -**--visibility-archival-state** _string-enum_ - -Visibility archival state. Accepted values: disabled, enabled. (default "disabled") - -**--visibility-uri** _string_ - -Archive visibility data to this `URI`. Once enabled, can't be changed. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### delete - -Removes a Namespace from the Service. - -``` -temporal operator namespace delete [options] -``` - -For example: - -``` -temporal operator namespace delete \ - --namespace YourNamespaceName -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--yes**, **-y** _bool_ - -Request confirmation before deletion. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### describe - -Provide long-form information about a Namespace identified by its ID or name: - -``` -temporal operator namespace describe \ - --namespace-id YourNamespaceId -``` - -or - -``` -temporal operator namespace describe \ - --namespace YourNamespaceName -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--namespace-id** _string_ - -Namespace ID. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### list - -Display a detailed listing for all Namespaces on the Service: - -``` -temporal operator namespace list -``` - -Use the following options to change the behavior of this command. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### update - -Update a Namespace using properties you specify. - -``` -temporal operator namespace update [options] -``` - -Assign a Namespace's active Cluster (Service): - -``` -temporal operator namespace update \ - --namespace YourNamespaceName \ - --active-cluster NewActiveCluster -``` - -Promote a Namespace for multi-region data replication: - -``` -temporal operator namespace update \ - --namespace YourNamespaceName \ - --promote-global -``` - -You may update archives that were previously enabled or disabled. Note: URI -values for archival states can't be changed once enabled. - -``` -temporal operator namespace update \ - --namespace YourNamespaceName \ - --history-archival-state enabled \ - --visibility-archival-state disabled -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--active-cluster** _string_ - -Active Cluster (Service) name. - -**--cluster** _string[]_ - -Cluster (Service) names. - -**--data** _string[]_ - -Namespace data as `KEY=VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. - -**--description** _string_ - -Namespace description. - -**--email** _string_ - -Owner email. - -**--history-archival-state** _string-enum_ - -History archival state. Accepted values: disabled, enabled. - -**--history-uri** _string_ - -Archive history to this `URI`. Once enabled, can't be changed. - -**--promote-global** _bool_ - -Enable multi-region data replication. - -**--replication-state** _string-enum_ - -Replication state. Accepted values: normal, handover. - -**--retention** _duration_ - -Length of time a closed Workflow is preserved before deletion. - -**--visibility-archival-state** _string-enum_ - -Visibility archival state. Accepted values: disabled, enabled. - -**--visibility-uri** _string_ - -Archive visibility data to this `URI`. Once enabled, can't be changed. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## nexus - -These commands manage Nexus resources. - -Nexus commands follow this syntax: - -``` -temporal operator nexus [command] [subcommand] [options] -``` - -### endpoint - -These commands manage Nexus Endpoints. - -Nexus Endpoint commands follow this syntax: - -``` -temporal operator nexus endpoint [command] [options] -``` - -#### create - -Create a Nexus Endpoint on the Server. - -A Nexus Endpoint name is used in Workflow code to invoke Nexus Operations. -The endpoint target may either be a Worker, in which case -`--target-namespace` and `--target-task-queue` must both be provided, or -an external URL, in which case `--target-url` must be provided. - -This command will fail if an Endpoint with the same name is already -registered. - -``` -temporal operator nexus endpoint create \ - --name your-endpoint \ - --target-namespace your-namespace \ - --target-task-queue your-task-queue \ - --description-file DESCRIPTION.md -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--description** _string_ - -Nexus Endpoint description. You may use Markdown formatting in the Nexus Endpoint description. - -**--description-file** _string_ - -Path to the Nexus Endpoint description file. The contents of the description file may use Markdown formatting. - -**--name** _string_ - -Endpoint name. Required. - -**--target-namespace** _string_ - -Namespace where a handler Worker polls for Nexus tasks. - -**--target-task-queue** _string_ - -Task Queue that a handler Worker polls for Nexus tasks. - -**--target-url** _string_ - -An external Nexus Endpoint that receives forwarded Nexus requests. May be used as an alternative to `--target-namespace` and `--target-task-queue`. - -:::note - -Option is experimental. - -::: - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -#### delete - -Delete a Nexus Endpoint from the Server. - -``` -temporal operator nexus endpoint delete --name your-endpoint -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--name** _string_ - -Endpoint name. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -#### get - -Get a Nexus Endpoint by name from the Server. - -``` -temporal operator nexus endpoint get --name your-endpoint -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--name** _string_ - -Endpoint name. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -#### list - -List all Nexus Endpoints on the Server. - -``` -temporal operator nexus endpoint list -``` - -Use the following options to change the behavior of this command. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -#### update - -Update an existing Nexus Endpoint on the Server. - -A Nexus Endpoint name is used in Workflow code to invoke Nexus Operations. -The Endpoint target may either be a Worker, in which case -`--target-namespace` and `--target-task-queue` must both be provided, or -an external URL, in which case `--target-url` must be provided. - -The Endpoint is patched; existing fields for which flags are not provided -are left as they were. - -Update only the target task queue: - -``` -temporal operator nexus endpoint update \ - --name your-endpoint \ - --target-task-queue your-other-queue -``` - -Update only the description: - -``` -temporal operator nexus endpoint update \ - --name your-endpoint \ - --description-file DESCRIPTION.md -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--description** _string_ - -Nexus Endpoint description. You may use Markdown formatting in the Nexus Endpoint description. - -**--description-file** _string_ - -Path to the Nexus Endpoint description file. The contents of the description file may use Markdown formatting. - -**--name** _string_ - -Endpoint name. Required. - -**--target-namespace** _string_ - -Namespace where a handler Worker polls for Nexus tasks. - -**--target-task-queue** _string_ - -Task Queue that a handler Worker polls for Nexus tasks. - -**--target-url** _string_ - -An external Nexus Endpoint that receives forwarded Nexus requests. May be used as an alternative to `--target-namespace` and `--target-task-queue`. - -:::note - -Option is experimental. - -::: - -**--unset-description** _bool_ - -Unset the description. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## search-attribute - -Create, list, or remove Search Attributes fields stored in a Workflow -Execution's metadata: - -``` -temporal operator search-attribute create \ - --name YourAttributeName \ - --type Keyword -``` - -Supported types include: Text, Keyword, Int, Double, Bool, Datetime, and -KeywordList. - -If you wish to delete a Search Attribute, please contact support -at https://support.temporal.io. - -### create - -Add one or more custom Search Attributes: - -``` -temporal operator search-attribute create \ - --name YourAttributeName \ - --type Keyword -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--name** _string[]_ - -Search Attribute name. Required. - -**--type** _string-enum[]_ - -Search Attribute type. Required. Accepted values: Text, Keyword, Int, Double, Bool, Datetime, KeywordList. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### list - -Display a list of active Search Attributes that can be assigned or used with -Workflow Queries. You can manage this list and add attributes as needed: - -``` -temporal operator search-attribute list -``` - -Use the following options to change the behavior of this command. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### remove - -Remove custom Search Attributes from the options that can be assigned or used -with Workflow Queries. - -``` -temporal operator search-attribute remove \ - --name YourAttributeName -``` - -Remove attributes without confirmation: - -``` -temporal operator search-attribute remove \ - --name YourAttributeName \ - --yes -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--name** _string[]_ - -Search Attribute name. Required. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm removal. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - diff --git a/temporalcli/docs/schedule.mdx b/temporalcli/docs/schedule.mdx deleted file mode 100644 index 80670c5cc..000000000 --- a/temporalcli/docs/schedule.mdx +++ /dev/null @@ -1,1725 +0,0 @@ -{/* 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 */} ---- -id: schedule -title: Temporal CLI schedule command reference -sidebar_label: schedule -description: Temporal's Schedule commands allow users to create, update, and manage Workflow Executions seamlessly for automation, supporting commands for creation, backfill, deletion, and more. -toc_max_heading_level: 4 -keywords: - - backfill - - cli reference - - command-line-interface-cli - - schedule - - schedule backfill - - schedule create - - schedule delete - - schedule describe - - schedule list - - schedule toggle - - schedule trigger - - schedule update - - temporal cli - - updates -tags: - - Temporal CLI - - Schedules ---- - -## backfill - -Batch-execute actions that would have run during a specified time interval. -Use this command to fill in Workflow runs from when a Schedule was paused, -before a Schedule was created, from the future, or to re-process a previously -executed interval. - -Backfills require a Schedule ID and the time period covered by the request. -It's best to use the `BufferAll` or `AllowAll` policies to avoid conflicts -and ensure no Workflow Executions are skipped. - -For example: - -``` -temporal schedule backfill \ - --schedule-id "YourScheduleId" \ - --start-time "2022-05-01T00:00:00Z" \ - --end-time "2022-05-31T23:59:59Z" \ - --overlap-policy BufferAll -``` - -The policies include: - -* **AllowAll**: Allow unlimited concurrent Workflow Executions. This - significantly speeds up the backfilling process on systems that support - concurrency. You must ensure running Workflow Executions do not interfere - with each other. -* **BufferAll**: Buffer all incoming Workflow Executions while waiting for - the running Workflow Execution to complete. -* **Skip**: If a previous Workflow Execution is still running, discard new - Workflow Executions. -* **BufferOne**: Same as 'Skip' but buffer a single Workflow Execution to be - run after the previous Execution completes. Discard other Workflow - Executions. -* **CancelOther**: Cancel the running Workflow Execution and replace it with - the incoming new Workflow Execution. -* **TerminateOther**: Terminate the running Workflow Execution and replace - it with the incoming new Workflow Execution. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--end-time** _timestamp_ - -Backfill end time. Required. - -**--overlap-policy** _string-enum_ - -Policy for handling overlapping Workflow Executions. Accepted values: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. (default "Skip") - -**--schedule-id**, **-s** _string_ - -Schedule ID. Required. - -**--start-time** _timestamp_ - -Backfill start time. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## create - -Create a new Schedule on the Temporal Service. A Schedule automatically starts -new Workflow Executions at the times you specify. - -For example: - -``` - temporal schedule create \ - --schedule-id "YourScheduleId" \ - --calendar '{"dayOfWeek":"Fri","hour":"3","minute":"30"}' \ - --workflow-id YourBaseWorkflowIdName \ - --task-queue YourTaskQueue \ - --type YourWorkflowType -``` - -Schedules support any combination of `--calendar`, `--interval`, and `--cron`: - -* Shorthand `--interval` strings. - For example: 45m (every 45 minutes) or 6h/5h (every 6 hours, at the top of - the 5th hour). -* JSON `--calendar`, as in the preceding example. -* Unix-style `--cron` strings and robfig declarations - (@daily/@weekly/@every X/etc). - For example, every Friday at 12:30 PM: `30 12 * * Fri`. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--calendar** _string[]_ - -Calendar specification in JSON. For example: `{"dayOfWeek":"Fri","hour":"17","minute":"5"}`. - -**--catchup-window** _duration_ - -Maximum catch-up time for when the Service is unavailable. - -**--cron** _string[]_ - -Calendar specification in cron string format. For example: `"30 12 * * Fri"`. - -**--end-time** _timestamp_ - -Schedule end time. - -**--execution-timeout** _duration_ - -Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. - -**--input**, **-i** _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** _bool_ - -Assume inputs are base64-encoded and attempt to decode them. - -**--input-file** _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** _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. - -**--interval** _string[]_ - -Interval duration. For example, 90m, or 60m/15m to include phase offset. - -**--jitter** _duration_ - -Max difference in time from the specification. Vary the start time randomly within this amount. - -**--memo** _string[]_ - -Memo using 'KEY="VALUE"' pairs. Use JSON values. - -**--notes** _string_ - -Initial notes field value. - -**--overlap-policy** _string-enum_ - -Policy for handling overlapping Workflow Executions. Accepted values: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. (default "Skip") - -**--pause-on-failure** _bool_ - -Pause schedule after Workflow failures. - -**--paused** _bool_ - -Pause the Schedule immediately on creation. - -**--remaining-actions** _int_ - -Total allowed actions. Default is zero (unlimited). - -**--run-timeout** _duration_ - -Fail a Workflow Run if it lasts longer than `DURATION`. - -**--schedule-id**, **-s** _string_ - -Schedule ID. Required. - -**--schedule-memo** _string[]_ - -Set schedule memo using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. - -**--schedule-search-attribute** _string[]_ - -Set schedule Search Attributes using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. - -**--search-attribute** _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. - -**--start-time** _timestamp_ - -Schedule start time. - -**--static-details** _string_ - -Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. - -:::note - -Option is experimental. - -::: - -**--static-summary** _string_ - -Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. - -:::note - -Option is experimental. - -::: - -**--task-queue**, **-t** _string_ - -Workflow Task queue. Required. - -**--task-timeout** _duration_ - -Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") - -**--time-zone** _string_ - -Interpret calendar specs with the `TZ` time zone. For a list of time zones, see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. - -**--type** _string_ - -Workflow Type name. Required. - -**--workflow-id**, **-w** _string_ - -Workflow ID. If not supplied, the Service generates a unique ID. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## delete - -Deletes a Schedule on the front end Service: - -``` -temporal schedule delete \ - --schedule-id YourScheduleId -``` - -Removing a Schedule won't affect the Workflow Executions it started that are -still running. To cancel or terminate these Workflow Executions, use `temporal -workflow delete` with the `TemporalScheduledById` Search Attribute instead. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--schedule-id**, **-s** _string_ - -Schedule ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## describe - -Show a Schedule configuration, including information about past, current, and -future Workflow runs: - -``` -temporal schedule describe \ - --schedule-id YourScheduleId -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--schedule-id**, **-s** _string_ - -Schedule ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## list - -Lists the Schedules hosted by a Namespace: - -``` -temporal schedule list \ - --namespace YourNamespace -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--long**, **-l** _bool_ - -Show detailed information. - -**--query**, **-q** _string_ - -Filter results using given List Filter. - -**--really-long** _bool_ - -Show extensive information in non-table form. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## toggle - -Pause or unpause a Schedule by passing a flag with your desired state: - -``` -temporal schedule toggle \ - --schedule-id "YourScheduleId" \ - --pause \ - --reason "YourReason" -``` - -and - -``` -temporal schedule toggle - --schedule-id "YourScheduleId" \ - --unpause \ - --reason "YourReason" -``` - -The `--reason` text updates the Schedule's `notes` field for operations -communication. It defaults to "(no reason provided)" if omitted. This field is -also visible on the Service Web UI. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--pause** _bool_ - -Pause the Schedule. - -**--reason** _string_ - -Reason for pausing or unpausing the Schedule. (default "(no reason provided)") - -**--schedule-id**, **-s** _string_ - -Schedule ID. Required. - -**--unpause** _bool_ - -Unpause the Schedule. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## trigger - -Trigger a Schedule to run immediately: - -``` -temporal schedule trigger \ - --schedule-id "YourScheduleId" -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--overlap-policy** _string-enum_ - -Policy for handling overlapping Workflow Executions. Accepted values: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. (default "Skip") - -**--schedule-id**, **-s** _string_ - -Schedule ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## update - -Update an existing Schedule with new configuration details, including time -specifications, action, and policies: - -``` -temporal schedule update \ - --schedule-id "YourScheduleId" \ - --workflow-type "NewWorkflowType" -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--calendar** _string[]_ - -Calendar specification in JSON. For example: `{"dayOfWeek":"Fri","hour":"17","minute":"5"}`. - -**--catchup-window** _duration_ - -Maximum catch-up time for when the Service is unavailable. - -**--cron** _string[]_ - -Calendar specification in cron string format. For example: `"30 12 * * Fri"`. - -**--end-time** _timestamp_ - -Schedule end time. - -**--execution-timeout** _duration_ - -Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. - -**--input**, **-i** _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** _bool_ - -Assume inputs are base64-encoded and attempt to decode them. - -**--input-file** _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** _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. - -**--interval** _string[]_ - -Interval duration. For example, 90m, or 60m/15m to include phase offset. - -**--jitter** _duration_ - -Max difference in time from the specification. Vary the start time randomly within this amount. - -**--memo** _string[]_ - -Memo using 'KEY="VALUE"' pairs. Use JSON values. - -**--notes** _string_ - -Initial notes field value. - -**--overlap-policy** _string-enum_ - -Policy for handling overlapping Workflow Executions. Accepted values: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll. (default "Skip") - -**--pause-on-failure** _bool_ - -Pause schedule after Workflow failures. - -**--paused** _bool_ - -Pause the Schedule immediately on creation. - -**--remaining-actions** _int_ - -Total allowed actions. Default is zero (unlimited). - -**--run-timeout** _duration_ - -Fail a Workflow Run if it lasts longer than `DURATION`. - -**--schedule-id**, **-s** _string_ - -Schedule ID. Required. - -**--schedule-memo** _string[]_ - -Set schedule memo using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. - -**--schedule-search-attribute** _string[]_ - -Set schedule Search Attributes using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. - -**--search-attribute** _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. - -**--start-time** _timestamp_ - -Schedule start time. - -**--static-details** _string_ - -Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. - -:::note - -Option is experimental. - -::: - -**--static-summary** _string_ - -Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. - -:::note - -Option is experimental. - -::: - -**--task-queue**, **-t** _string_ - -Workflow Task queue. Required. - -**--task-timeout** _duration_ - -Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") - -**--time-zone** _string_ - -Interpret calendar specs with the `TZ` time zone. For a list of time zones, see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. - -**--type** _string_ - -Workflow Type name. Required. - -**--workflow-id**, **-w** _string_ - -Workflow ID. If not supplied, the Service generates a unique ID. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - diff --git a/temporalcli/docs/server.mdx b/temporalcli/docs/server.mdx deleted file mode 100644 index 012183b8e..000000000 --- a/temporalcli/docs/server.mdx +++ /dev/null @@ -1,277 +0,0 @@ -{/* 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 */} ---- -id: server -title: Temporal CLI server command reference -sidebar_label: server -description: Manage your Temporal Server easily with CLI commands. Start a local server using `temporal server start-dev` and access the Web UI at http://localhost:8233. Customize with multiple options. -toc_max_heading_level: 4 -keywords: - - cli reference - - command-line-interface-cli - - server - - server start-dev - - temporal cli -tags: - - Temporal CLI - - Development Server ---- - -## start-dev - -Run a development Temporal Server on your local system. - -+------------------------------------------------------------------------+ -| WARNING: The development server is not intended for production use. | -| It skips certain HTTP security checks to make local use simpler. | -| | -| For production use, see: | -| https://docs.temporal.io/production-deployment | -+------------------------------------------------------------------------+ - -View the Web UI for the default configuration at: http://localhost:8233 - -``` -temporal server start-dev -``` - -Add persistence for Workflow Executions across runs: - -``` -temporal server start-dev \ - --db-filename path-to-your-local-persistent-store -``` - -Set the port from the front-end gRPC Service (7233 default): - -``` -temporal server start-dev \ - --port 7000 -``` - -Use a custom port for the Web UI. The default is the gRPC port (7233 default) -plus 1000 (8233): - -``` -temporal server start-dev \ - --ui-port 3000 -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--db-filename**, **-f** _string_ - -Path to file for persistent Temporal state store. By default, Workflow Executions are lost when the server process dies. - -**--dynamic-config-value** _string[]_ - -Dynamic configuration value using `KEY=VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: 'YourKey="YourString"'. Can be passed multiple times. - -**--headless** _bool_ - -Disable the Web UI. - -**--http-port** _int_ - -Port for the HTTP API service. Defaults to a random free port. (default "0") - -**--ip** _string_ - -IP address bound to the front-end Service. (default "localhost") - -**--log-config** _bool_ - -Log the server config to stderr. - -**--metrics-port** _int_ - -Port for '/metrics'. Default is off. - -**--namespace**, **-n** _string[]_ - -Namespaces to be created at launch. The "default" Namespace is always created automatically. - -**--port**, **-p** _int_ - -Port for the front-end gRPC Service. (default "7233") - -**--search-attribute** _string[]_ - -Search attributes to register using `KEY=VALUE` pairs. Keys must be identifiers, and values must be the search attribute type, which is one of the following: Text, Keyword, Int, Double, Bool, Datetime, KeywordList. - -**--sqlite-pragma** _string[]_ - -SQLite pragma statements in "PRAGMA=VALUE" format. - -**--ui-asset-path** _string_ - -UI custom assets path. - -**--ui-codec-endpoint** _string_ - -UI remote codec HTTP endpoint. - -**--ui-ip** _string_ - -IP address bound to the Web UI. Default is same as '--ip' value. - -**--ui-port** _int_ - -Port for the Web UI. Default is '--port' value + 1000. - -**--ui-public-path** _string_ - -The public base path for the Web UI. Default is `/`. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - diff --git a/temporalcli/docs/task-queue.mdx b/temporalcli/docs/task-queue.mdx deleted file mode 100644 index 2eb92a14b..000000000 --- a/temporalcli/docs/task-queue.mdx +++ /dev/null @@ -1,3090 +0,0 @@ -{/* 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 */} ---- -id: task-queue -title: Temporal CLI task-queue command reference -sidebar_label: task-queue -description: Temporal Task Queue commands facilitate operations like describing poller info, displaying partitions, fetching compatible Build IDs, and determining Build ID reachability for effective Workflow and Activity management. -toc_max_heading_level: 4 -keywords: - - cli reference - - command-line-interface-cli - - list partitions - - task queue - - task queue describe - - temporal cli -tags: - - Temporal CLI ---- - -## describe - -Display a list of active Workers that have recently polled a Task Queue. The -Temporal Server records each poll request time. A `LastAccessTime` over one -minute may indicate the Worker is at capacity or has shut down. Temporal -Workers are removed if 5 minutes have passed since the last poll request. - -``` -temporal task-queue describe \ - --task-queue YourTaskQueue -``` - -This command provides poller information for a given Task Queue. -Workflow and Activity polling use separate Task Queues: - -``` -temporal task-queue describe \ - --task-queue YourTaskQueue \ - --task-queue-type "activity" -``` - -This command provides the following task queue statistics: -- `ApproximateBacklogCount`: The approximate number of tasks backlogged in this - task queue. May count expired tasks but eventually converges to the right - value. -- `ApproximateBacklogAge`: Approximate age of the oldest task in the backlog, - based on its creation time, measured in seconds. -- `TasksAddRate`: Approximate rate at which tasks are being added to the task - queue, measured in tasks per second, averaged over the last 30 seconds. - Includes tasks dispatched immediately without going to the backlog - (sync-matched tasks), as well as tasks added to the backlog. (See note below.) -- `TasksDispatchRate`: Approximate rate at which tasks are being dispatched from - the task queue, measured in tasks per second, averaged over the last 30 - seconds. Includes tasks dispatched immediately without going to the backlog - (sync-matched tasks), as well as tasks added to the backlog. (See note below.) -- `BacklogIncreaseRate`: Approximate rate at which the backlog size is - increasing (if positive) or decreasing (if negative), measured in tasks per - second, averaged over the last 30 seconds. This is roughly equivalent to: - `TasksAddRate` - `TasksDispatchRate`. - -NOTE: The `TasksAddRate` and `TasksDispatchRate` metrics may differ from the -actual rate of add/dispatch, because tasks may be dispatched eagerly to an -available worker, or may apply only to specific workers (they are "sticky"). -Such tasks are not counted by these metrics. Despite the inaccuracy of -these two metrics, the derived metric of `BacklogIncreaseRate` is accurate -for backlogs older than a few seconds. - -Safely retire Workers assigned a Build ID by checking reachability across -all task types. Use the flag `--report-reachability`: - -``` -temporal task-queue describe \ - --task-queue YourTaskQueue \ - --build-id "YourBuildId" \ - --report-reachability -``` - -Task reachability information is returned for the requested versions and all -task types, which can be used to safely retire Workers with old code versions, -provided that they were assigned a Build ID. - -Note that task reachability status is experimental and may significantly change -or be removed in a future release. Also, determining task reachability incurs a -non-trivial computing cost. - -Task reachability states are reported per build ID. The state may be one of the -following: - -- `Reachable`: using the current versioning rules, the Build ID may be used - by new Workflow Executions or Activities OR there are currently open - Workflow or backlogged Activity tasks assigned to the queue. -- `ClosedWorkflowsOnly`: the Build ID does not have open Workflow Executions - and can't be reached by new Workflow Executions. It MAY have closed - Workflow Executions within the Namespace retention period. -- `Unreachable`: this Build ID is not used for new Workflow Executions and - isn't used by any existing Workflow Execution within the retention period. - -Task reachability is eventually consistent. You may experience a delay until -reachability converges to the most accurate value. This is designed to act -in the most conservative way until convergence. For example, `Reachable` is -more conservative than `ClosedWorkflowsOnly`. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--disable-stats** _bool_ - -Disable task queue statistics. - -**--legacy-mode** _bool_ - -Enable a legacy mode for servers that do not support rules-based worker versioning. This mode only provides pollers info. - -**--partitions-legacy** _int_ - -Query partitions 1 through `N`. Experimental/Temporary feature. Legacy mode only. (default "1") - -**--report-reachability** _bool_ - -Display task reachability information. - -**--select-all-active** _bool_ - -Include all active versions. A version is active if it had new tasks or polls recently. - -**--select-build-id** _string[]_ - -Filter the Task Queue based on Build ID. - -**--select-unversioned** _bool_ - -Include the unversioned queue. - -**--task-queue**, **-t** _string_ - -Task Queue name. Required. - -**--task-queue-type** _string-enum[]_ - -Task Queue type. If not specified, all types are reported. Accepted values: workflow, activity, nexus. - -**--task-queue-type-legacy** _string-enum_ - -Task Queue type (legacy mode only). Accepted values: workflow, activity. (default "workflow") - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## get-build-id-reachability - -+-----------------------------------------------------------------------------+ -| CAUTION: This command is deprecated and will be removed in a later release. | -+-----------------------------------------------------------------------------+ - -Show if a given Build ID can be used for new, existing, or closed Workflows -in Namespaces that support Worker versioning: - -``` -temporal task-queue get-build-id-reachability \ - --task-queue YourTaskQueue \ - --build-id "YourBuildId" -``` - -You can specify the `--build-id` and `--task-queue` flags multiple times. If -`--task-queue` is omitted, the command checks Build ID reachability against -all Task Queues. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string[]_ - -One or more Build ID strings. Can be passed multiple times. - -**--reachability-type** _string-enum_ - -Reachability filter. `open`: reachable by one or more open workflows. `closed`: reachable by one or more closed workflows. `existing`: reachable by either. New Workflow Executions reachable by a Build ID are always reported. Accepted values: open, closed, existing. (default "existing") - -**--task-queue**, **-t** _string[]_ - -Search only the specified task queue(s). Can be passed multiple times. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## get-build-ids - -+-----------------------------------------------------------------------------+ -| CAUTION: This command is deprecated and will be removed in a later release. | -+-----------------------------------------------------------------------------+ - -Fetch sets of compatible Build IDs for specified Task Queues and display their -information: - -``` -temporal task-queue get-build-ids \ - --task-queue YourTaskQueue -``` - -This command is limited to Namespaces that support Worker versioning. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--max-sets** _int_ - -Max return count. Use 1 for default major version. Use 0 for all sets. (default "0") - -**--task-queue**, **-t** _string_ - -Task Queue name. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## list-partition - -Display a Task Queue's partition list with assigned matching nodes: - -``` -temporal task-queue list-partition \ - --task-queue YourTaskQueue -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--task-queue**, **-t** _string_ - -Task Queue name. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## update-build-ids - -+-----------------------------------------------------------------------------+ -| CAUTION: This command is deprecated and will be removed in a later release. | -+-----------------------------------------------------------------------------+ - -Add or change a Task Queue's compatible Build IDs for Namespaces using Worker -versioning: - -``` -temporal task-queue update-build-ids [subcommands] [options] \ - --task-queue YourTaskQueue -``` - -### add-new-compatible - -Add a compatible Build ID to a Task Queue's existing version set. Provide an -existing Build ID and a new Build ID: - -``` -temporal task-queue update-build-ids add-new-compatible \ - --task-queue YourTaskQueue \ - --existing-compatible-build-id "YourExistingBuildId" \ - --build-id "YourNewBuildId" -``` - -The new ID is stored in the set containing the existing ID and becomes the new -default for that set. - -This command is limited to Namespaces that support Worker versioning. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string_ - -Build ID to be added. Required. - -**--existing-compatible-build-id** _string_ - -Pre-existing Build ID in this Task Queue. Required. - -**--set-as-default** _bool_ - -Set the expanded Build ID set as the Task Queue default. - -**--task-queue**, **-t** _string_ - -Task Queue name. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### add-new-default - -+-----------------------------------------------------------------------------+ -| CAUTION: This command is deprecated and will be removed in a later release. | -+-----------------------------------------------------------------------------+ - -Create a new Task Queue Build ID set, add a Build ID to it, and make it the -overall Task Queue default. The new set will be incompatible with previous -sets and versions. - -``` -temporal task-queue update-build-ids add-new-default \ - --task-queue YourTaskQueue \ - --build-id "YourNewBuildId" -``` - -+------------------------------------------------------------------------+ -| NOTICE: This command is limited to Namespaces that support Worker | -| versioning. Worker versioning is experimental. Versioning commands are | -| subject to change. | -+------------------------------------------------------------------------+ - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string_ - -Build ID to be added. Required. - -**--task-queue**, **-t** _string_ - -Task Queue name. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### promote-id-in-set - -+-----------------------------------------------------------------------------+ -| CAUTION: This command is deprecated and will be removed in a later release. | -+-----------------------------------------------------------------------------+ - -Establish an existing Build ID as the default in its Task Queue set. New tasks -compatible with this set will now be dispatched to this ID: - -``` -temporal task-queue update-build-ids promote-id-in-set \ - --task-queue YourTaskQueue \ - --build-id "YourBuildId" -``` - -+------------------------------------------------------------------------+ -| NOTICE: This command is limited to Namespaces that support Worker | -| versioning. Worker versioning is experimental. Versioning commands are | -| subject to change. | -+------------------------------------------------------------------------+ - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string_ - -Build ID to set as default. Required. - -**--task-queue**, **-t** _string_ - -Task Queue name. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### promote-set - -+-----------------------------------------------------------------------------+ -| CAUTION: This command is deprecated and will be removed in a later release. | -+-----------------------------------------------------------------------------+ - -Promote a Build ID set to be the default on a Task Queue. Identify the set by -providing a Build ID within it. If the set is already the default, this -command has no effect: - -``` -temporal task-queue update-build-ids promote-set \ - --task-queue YourTaskQueue \ - --build-id "YourBuildId" -``` - -+------------------------------------------------------------------------+ -| NOTICE: This command is limited to Namespaces that support Worker | -| versioning. Worker versioning is experimental. Versioning commands are | -| subject to change. | -+------------------------------------------------------------------------+ - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string_ - -Build ID within the promoted set. Required. - -**--task-queue**, **-t** _string_ - -Task Queue name. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## versioning - -+---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | -+---------------------------------------------------------------------+ - -Provides commands to add, list, remove, or replace Worker Build ID assignment -and redirect rules associated with Task Queues: - -``` -temporal task-queue versioning [subcommands] [options] \ - --task-queue YourTaskQueue -``` - -Task Queues support the following versioning rules and policies: - -- Assignment Rules: manage how new executions are assigned to run on specific - Worker Build IDs. Each Task Queue stores a list of ordered Assignment Rules, - which are evaluated from first to last. Assignment Rules also allow for - gradual rollout of new Build IDs by setting ramp percentage. -- Redirect Rules: automatically assign work for a source Build ID to a target - Build ID. You may add at most one redirect rule for each source Build ID. - Redirect rules require that a target Build ID is fully compatible with - the source Build ID. - -### add-redirect-rule - -Add a new redirect rule for a given Task Queue. You may add at most one -redirect rule for each distinct source build ID: - -``` -temporal task-queue versioning add-redirect-rule \ - --task-queue YourTaskQueue \ - --source-build-id "YourSourceBuildID" \ - --target-build-id "YourTargetBuildID" -``` - -+---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | -+---------------------------------------------------------------------+ - -Use the following options to change the behavior of this command. - -**Flags:** - -**--source-build-id** _string_ - -Source build ID. Required. - -**--target-build-id** _string_ - -Target build ID. Required. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### commit-build-id - -Complete a Build ID's rollout and clean up unnecessary rules that might have -been created during a gradual rollout: - -``` -temporal task-queue versioning commit-build-id \ - --task-queue YourTaskQueue - --build-id "YourBuildId" -``` - -This command automatically applies the following atomic changes: - -- Adds an unconditional assignment rule for the target Build ID at the - end of the list. -- Removes all previously added assignment rules to the given target - Build ID. -- Removes any unconditional assignment rules for other Build IDs. - -Rejects requests when there have been no recent pollers for this Build ID. -This prevents committing invalid Build IDs. Use the `--force` option to -override this validation. - -+---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | -+---------------------------------------------------------------------+ - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string_ - -Target build ID. Required. - -**--force** _bool_ - -Bypass recent-poller validation. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### delete-assignment-rule - -Deletes a rule identified by its index in the Task Queue's list of assignment -rules. - -``` -temporal task-queue versioning delete-assignment-rule \ - --task-queue YourTaskQueue \ - --rule-index YourIntegerRuleIndex -``` - -By default, the Task Queue must retain one unconditional rule, such as "no -hint filter" or "percentage". Otherwise, the delete operation is rejected. -Use the `--force` option to override this validation. - -+---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | -+---------------------------------------------------------------------+ - -Use the following options to change the behavior of this command. - -**Flags:** - -**--force** _bool_ - -Bypass one-unconditional-rule validation. - -**--rule-index**, **-i** _int_ - -Position of the assignment rule to be replaced. Requests for invalid indices will fail. Required. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### delete-redirect-rule - -Deletes the routing rule for the given source Build ID. - -``` -temporal task-queue versioning delete-redirect-rule \ - --task-queue YourTaskQueue \ - --source-build-id "YourBuildId" -``` - -+---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | -+---------------------------------------------------------------------+ - -Use the following options to change the behavior of this command. - -**Flags:** - -**--source-build-id** _string_ - -Source Build ID. Required. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### get-rules - -Retrieve all the Worker Build ID assignments and redirect rules associated -with a Task Queue: - -``` -temporal task-queue versioning get-rules \ - --task-queue YourTaskQueue -``` - -Task Queues support the following versioning rules: - -- Assignment Rules: manage how new executions are assigned to run on specific - Worker Build IDs. Each Task Queue stores a list of ordered Assignment Rules, - which are evaluated from first to last. Assignment Rules also allow for - gradual rollout of new Build IDs by setting ramp percentage. -- Redirect Rules: automatically assign work for a source Build ID to a target - Build ID. You may add at most one redirect rule for each source Build ID. - Redirect rules require that a target Build ID is fully compatible with - the source Build ID. -+---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | -+---------------------------------------------------------------------+ - -Use the following options to change the behavior of this command. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### insert-assignment-rule - -Inserts a new assignment rule for this Task Queue. Rules are evaluated in -order, starting from index 0. The first applicable rule is applied, and the -rest ignored: - -``` -temporal task-queue versioning insert-assignment-rule \ - --task-queue YourTaskQueue \ - --build-id "YourBuildId" -``` - -If you do not specify a `--rule-index`, this command inserts at index 0. - -+---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | -+---------------------------------------------------------------------+ - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string_ - -Target Build ID. Required. - -**--percentage** _int_ - -Traffic percent to send to target Build ID. (default "100") - -**--rule-index**, **-i** _int_ - -Insertion position. Ranges from 0 (insert at start) to count (append). Any number greater than the count is treated as "append". (default "0") - -**--yes**, **-y** _bool_ - -Don't prompt to confirm. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### replace-assignment-rule - -Change an assignment rule for this Task Queue. By default, this enforces one -unconditional rule (no hint filter or percentage). Otherwise, the operation -will be rejected. Set `force` to true to bypass this validation. - -``` -temporal task-queue versioning replace-assignment-rule \ - --task-queue YourTaskQueue \ - --rule-index AnIntegerIndex \ - --build-id "YourBuildId" -``` - -To assign multiple assignment rules to a single Build ID, use -'insert-assignment-rule'. - -To update the percent: - -``` -temporal task-queue versioning replace-assignment-rule \ - --task-queue YourTaskQueue \ - --rule-index AnIntegerIndex \ - --build-id "YourBuildId" \ - --percentage AnIntegerPercent -``` - -Percent may vary between 0 and 100 (default). - -+---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | -+---------------------------------------------------------------------+ - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string_ - -Target Build ID. Required. - -**--force** _bool_ - -Bypass the validation that one unconditional rule remains. - -**--percentage** _int_ - -Divert percent of traffic to target Build ID. (default "100") - -**--rule-index**, **-i** _int_ - -Position of the assignment rule to be replaced. Requests for invalid indices will fail. Required. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### replace-redirect-rule - -Updates a Build ID's redirect rule on a Task Queue by replacing its target -Build ID: - -``` -temporal task-queue versioning replace-redirect-rule \ - --task-queue YourTaskQueue \ - --source-build-id YourSourceBuildId \ - --target-build-id YourNewTargetBuildId -``` - -+---------------------------------------------------------------------+ -| CAUTION: This API has been deprecated by Worker Deployment. | -+---------------------------------------------------------------------+ - -Use the following options to change the behavior of this command. - -**Flags:** - -**--source-build-id** _string_ - -Source Build ID. Required. - -**--target-build-id** _string_ - -Target Build ID. Required. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - diff --git a/temporalcli/docs/worker.mdx b/temporalcli/docs/worker.mdx deleted file mode 100644 index d929c81b8..000000000 --- a/temporalcli/docs/worker.mdx +++ /dev/null @@ -1,1613 +0,0 @@ -{/* 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 */} ---- -id: worker -title: Temporal CLI worker command reference -sidebar_label: worker -description: Learn how to read or modify state associated with a Worker, such as Worker Deployments. -toc_max_heading_level: 4 -keywords: - - worker - - worker deployment -tags: - - Temporal CLI ---- - -## deployment - -+---------------------------------------------------------------------+ -| CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | -+---------------------------------------------------------------------+ - -Deployment commands perform operations on Worker Deployments: - -``` -temporal worker deployment [command] [options] -``` - -For example: - -``` -temporal worker deployment list -``` - -Lists the Deployments in the client's namespace. - -Arguments can be Worker Deployment Versions associated with -a Deployment, specified using the Deployment name and Build ID. - -For example: - -``` -temporal worker deployment set-current-version \ - --deployment-name YourDeploymentName --build-id YourBuildID -``` - -Sets the current Deployment Version for a given Deployment. - -### delete - -+---------------------------------------------------------------------+ -| CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | -+---------------------------------------------------------------------+ - -Remove a Worker Deployment given its Deployment Name. -A Deployment can only be deleted if it has no Version in it. - -``` -temporal worker deployment delete [options] -``` - -For example, setting the user identity that removed the deployment: - -``` -temporal worker deployment delete \ - --name YourDeploymentName \ - --identity YourIdentity - -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--identity** _string_ - -Identity of the user submitting this request. - -**--name**, **-d** _string_ - -Name for a Worker Deployment. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### delete-version - -+---------------------------------------------------------------------+ -| CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | -+---------------------------------------------------------------------+ - -Remove a Worker Deployment Version given its fully-qualified identifier. -This is rarely needed during normal operation -since unused Versions are eventually garbage collected. -The client can delete a Version only when all of the following conditions -are met: - - It is not the Current or Ramping Version for this Deployment. - - It has no active pollers, i.e., none of the task queues in the - Version have pollers. - - It is not draining. This requirement can be ignored with the option -`--skip-drainage`. -``` -temporal worker deployment delete-version [options] -``` - -For example, skipping the drainage restriction: - -``` -temporal worker deployment delete-version \ - --deployment-name YourDeploymentName --build-id YourBuildID \ - --skip-drainage -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string_ - -Build ID of the Worker Deployment Version. Required. - -**--deployment-name** _string_ - -Name of the Worker Deployment. Required. - -**--identity** _string_ - -Identity of the user submitting this request. - -**--skip-drainage** _bool_ - -Ignore the deletion requirement of not draining. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### describe - -+---------------------------------------------------------------------+ -| CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | -+---------------------------------------------------------------------+ - -Describe properties of a Worker Deployment, such as the versions -associated with it, routing information of new or existing tasks -executed by this deployment, or its creation time. - -``` -temporal worker deployment describe [options] -``` - -For example, to describe a deployment `YourDeploymentName` in the default -namespace: - -``` -temporal worker deployment describe \ - --name YourDeploymentName -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--name**, **-d** _string_ - -Name for a Worker Deployment. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### describe-version - -+---------------------------------------------------------------------+ -| CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | -+---------------------------------------------------------------------+ - -Describe properties of a Worker Deployment Version, such as the task -queues polled by workers in this Deployment Version, or drainage -information required to safely decommission workers, or user-provided -metadata, or its creation/modification time. - -``` -temporal worker deployment describe-version [options] -``` - -For example, to describe a deployment version in a deployment -`YourDeploymentName`, with Build ID `YourBuildID`, and in the default -namespace: - -``` -temporal worker deployment describe-version \ - --deployment-name YourDeploymentName --build-id YourBuildID -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string_ - -Build ID of the Worker Deployment Version. Required. - -**--deployment-name** _string_ - -Name of the Worker Deployment. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### list - -+---------------------------------------------------------------------+ -| CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | -+---------------------------------------------------------------------+ - -List existing Worker Deployments in the client's namespace. - -``` -temporal worker deployment list [options] -``` - -For example, listing Deployments in YourDeploymentNamespace: - -``` -temporal worker deployment list \ - --namespace YourDeploymentNamespace -``` - -Use the following options to change the behavior of this command. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### set-current-version - -+---------------------------------------------------------------------+ -| CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | -+---------------------------------------------------------------------+ - -Set the Current Version for a Deployment. -When a Version is current, Workers of that Deployment Version will receive -tasks from new Workflows, and from existing AutoUpgrade Workflows that -are running on this Deployment. - -If not all the expected Task Queues are being polled by Workers in the -new Version the request will fail. To override this protection use -`--ignore-missing-task-queues`. Note that this would ignore task queues -in a deployment that are not yet discovered, leading to inconsistent task -queue configuration. - -``` -temporal worker deployment set-current-version [options] -``` - -For example, to set the Current Version of a deployment -`YourDeploymentName`, with a version with Build ID `YourBuildID`, and -in the default namespace: - -``` -temporal worker deployment set-current-version \ - --deployment-name YourDeploymentName --build-id YourBuildID -``` - -The target of set-current-version can also be unversioned workers: - -``` -temporal worker deployment set-current-version \ - --deployment-name YourDeploymentName --unversioned -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string_ - -Build ID of the Worker Deployment Version. Required unless --unversioned is specified. - -**--deployment-name** _string_ - -Name of the Worker Deployment. Required. - -**--identity** _string_ - -Identity of the user submitting this request. - -**--ignore-missing-task-queues** _bool_ - -Override protection to accidentally remove task queues. - -**--unversioned** _bool_ - -Set unversioned workers as the target version. Cannot be used with --build-id. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm set Current Version. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### set-ramping-version - -+---------------------------------------------------------------------+ -| CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | -+---------------------------------------------------------------------+ - -Set the Ramping Version and Percentage for a Deployment. - -The Ramping Version can be set using deployment name and build ID, -or set to unversioned workers using the --unversioned flag. - -The Ramping Percentage is a float with values in the range [0, 100]. -A value of 100 does not make the Ramping Version Current, use -`set-current-version` instead. - -To remove a Ramping Version use the flag `--delete`. - -If not all the expected Task Queues are being polled by Workers in the -new Ramping Version the request will fail. To override this protection use -`--ignore-missing-task-queues`. Note that this would ignore task queues -in a deployment that are not yet discovered, leading to inconsistent task -queue configuration. - -``` -temporal worker deployment set-ramping-version [options] -``` - -For example, to set the Ramping Version of a deployment -`YourDeploymentName`, with a version with Build ID `YourBuildID`, with -10 percent of tasks redirected to this version, and -using the default namespace: - -``` -temporal worker deployment set-ramping-version \ - --deployment-name YourDeploymentName --build-id YourBuildID \ - --percentage 10.0 -``` - -And to remove that ramping: -``` -temporal worker deployment set-ramping-version \ - --deployment-name YourDeploymentName --build-id YourBuildID \ - --delete -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string_ - -Build ID of the Worker Deployment Version. Required unless --unversioned is specified. - -**--delete** _bool_ - -Delete the Ramping Version. - -**--deployment-name** _string_ - -Name of the Worker Deployment. Required. - -**--identity** _string_ - -Identity of the user submitting this request. - -**--ignore-missing-task-queues** _bool_ - -Override protection to accidentally remove task queues. - -**--percentage** _float_ - -Percentage of tasks redirected to the Ramping Version. Valid range [0,100]. - -**--unversioned** _bool_ - -Set unversioned workers as the target version. Cannot be used with --build-id. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm set Ramping Version. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### update-metadata-version - -+---------------------------------------------------------------------+ -| CAUTION: Worker Deployment is experimental. Deployment commands are | -| subject to change. | -+---------------------------------------------------------------------+ -Update metadata associated with a Worker Deployment Version. - -For example: - -``` - temporal worker deployment update-metadata-version \ - --deployment-name YourDeploymentName --build-id YourBuildID \ - --metadata bar=1 \ - --metadata foo=true -``` - -The current metadata is also returned with `describe-version`: -``` - temporal worker deployment describe-version \ - --deployment-name YourDeploymentName --build-id YourBuildID \ -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--build-id** _string_ - -Build ID of the Worker Deployment Version. Required. - -**--deployment-name** _string_ - -Name of the Worker Deployment. Required. - -**--metadata** _string[]_ - -Set deployment metadata using `KEY="VALUE"` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. - -**--remove-entries** _string[]_ - -Keys of entries to be deleted from metadata. Can be passed multiple times. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - diff --git a/temporalcli/docs/workflow.mdx b/temporalcli/docs/workflow.mdx deleted file mode 100644 index 99e6b683c..000000000 --- a/temporalcli/docs/workflow.mdx +++ /dev/null @@ -1,5272 +0,0 @@ -{/* 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 */} ---- -id: workflow -title: Temporal CLI workflow command reference -sidebar_label: workflow -description: Temporal Workflow commands enable operations on Workflow Executions, such as cancel, count, delete, describe, execute, list, update-options, query, reset, reset-batch, show, signal, stack, start, terminate, trace, and update, enhancing efficiency and control. -toc_max_heading_level: 4 -keywords: - - call stack - - cancellation - - child workflows - - cli reference - - command-line-interface-cli - - event history - - query - - resets-feature - - signals - - signals-feature - - stack trace - - temporal cli - - termination - - workflow - - workflow cancel - - workflow count - - workflow delete - - workflow describe - - workflow execute - - workflow execution - - workflow list - - workflow metadata - - workflow query - - workflow reset - - workflow reset-batch - - workflow show - - workflow signal - - workflow stack - - workflow start - - workflow terminate - - workflow trace - - workflow update-options -tags: - - Temporal CLI - - Workflows ---- - -## cancel - -Canceling a running Workflow Execution records a -`WorkflowExecutionCancelRequested` event in the Event History. The Service -schedules a new Command Task, and the Workflow Execution performs any cleanup -work supported by its implementation. - -Use the Workflow ID to cancel an Execution: - -``` -temporal workflow cancel \ - --workflow-id YourWorkflowId -``` - -A visibility Query lets you send bulk cancellations to Workflow Executions -matching the results: - -``` -temporal workflow cancel \ - --query YourQuery -``` - -Visit https://docs.temporal.io/visibility to read more about Search Attributes -and Query creation. See `temporal batch --help` for a quick reference. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--query**, **-q** _string_ - -Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. - -**--reason** _string_ - -Reason for batch operation. Only use with --query. Defaults to user name. - -**--rps** _float_ - -Limit batch's requests per second. Only allowed if query is present. - -**--run-id**, **-r** _string_ - -Run ID. Only use with --workflow-id. Cannot use with --query. - -**--workflow-id**, **-w** _string_ - -Workflow ID. You must set either --workflow-id or --query. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm signaling. Only allowed when --query is present. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## count - -Show a count of Workflow Executions, regardless of execution state (running, -terminated, etc). Use `--query` to select a subset of Workflow Executions: - -``` -temporal workflow count \ - --query YourQuery -``` - -Visit https://docs.temporal.io/visibility to read more about Search Attributes -and Query creation. See `temporal batch --help` for a quick reference. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--query**, **-q** _string_ - -Content for an SQL-like `QUERY` List Filter. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## delete - -Delete a Workflow Executions and its Event History: - -``` -temporal workflow delete \ - --workflow-id YourWorkflowId -``` - -The removal executes asynchronously. If the Execution is Running, the Service -terminates it before deletion. - -Visit https://docs.temporal.io/visibility to read more about Search Attributes -and Query creation. See `temporal batch --help` for a quick reference. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--query**, **-q** _string_ - -Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. - -**--reason** _string_ - -Reason for batch operation. Only use with --query. Defaults to user name. - -**--rps** _float_ - -Limit batch's requests per second. Only allowed if query is present. - -**--run-id**, **-r** _string_ - -Run ID. Only use with --workflow-id. Cannot use with --query. - -**--workflow-id**, **-w** _string_ - -Workflow ID. You must set either --workflow-id or --query. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm signaling. Only allowed when --query is present. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## describe - -Display information about a specific Workflow Execution: - -``` -temporal workflow describe \ - --workflow-id YourWorkflowId -``` - -Show the Workflow Execution's auto-reset points: - -``` -temporal workflow describe \ - --workflow-id YourWorkflowId \ - --reset-points true -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--raw** _bool_ - -Print properties without changing their format. - -**--reset-points** _bool_ - -Show auto-reset points only. - -**--run-id**, **-r** _string_ - -Run ID. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## execute - -Establish a new Workflow Execution and direct its progress to stdout. The -command blocks and returns when the Workflow Execution completes. If your -Workflow requires input, pass valid JSON: - -``` -temporal workflow execute - --workflow-id YourWorkflowId \ - --type YourWorkflow \ - --task-queue YourTaskQueue \ - --input '{"some-key": "some-value"}' -``` - -Use `--event-details` to relay updates to the command-line output in JSON -format. When using JSON output (`--output json`), this includes the entire -"history" JSON key for the run. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--cron** _string_ - -Cron schedule for the Workflow. - -**--detailed** _bool_ - -Display events as sections instead of table. Does not apply to JSON output. - -**--execution-timeout** _duration_ - -Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. - -**--fail-existing** _bool_ - -Fail if the Workflow already exists. - -**--id-conflict-policy** _string-enum_ - -Determines how to resolve a conflict when spawning a new Workflow Execution with a particular Workflow Id used by an existing Open Workflow Execution. Accepted values: Fail, UseExisting, TerminateExisting. - -**--id-reuse-policy** _string-enum_ - -Re-use policy for the Workflow ID in new Workflow Executions. Accepted values: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. - -**--input**, **-i** _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** _bool_ - -Assume inputs are base64-encoded and attempt to decode them. - -**--input-file** _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** _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. - -**--memo** _string[]_ - -Memo using 'KEY="VALUE"' pairs. Use JSON values. - -**--run-timeout** _duration_ - -Fail a Workflow Run if it lasts longer than `DURATION`. - -**--search-attribute** _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. - -**--start-delay** _duration_ - -Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. - -**--static-details** _string_ - -Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. - -:::note - -Option is experimental. - -::: - -**--static-summary** _string_ - -Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. - -:::note - -Option is experimental. - -::: - -**--task-queue**, **-t** _string_ - -Workflow Task queue. Required. - -**--task-timeout** _duration_ - -Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") - -**--type** _string_ - -Workflow Type name. Required. - -**--workflow-id**, **-w** _string_ - -Workflow ID. If not supplied, the Service generates a unique ID. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## execute-update-with-start - -Send a message to a Workflow Execution to invoke an Update handler, and wait for -the update to complete. If the Workflow Execution is not running, then a new workflow -execution is started and the update is sent. - -Experimental. - -``` -temporal workflow execute-update-with-start \ - --update-name YourUpdate \ - --update-input '{"update-key": "update-value"}' \ - --workflow-id YourWorkflowId \ - --type YourWorkflowType \ - --task-queue YourTaskQueue \ - --id-conflict-policy Fail \ - --input '{"wf-key": "wf-value"}' -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--cron** _string_ - -Cron schedule for the Workflow. - -**--execution-timeout** _duration_ - -Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. - -**--fail-existing** _bool_ - -Fail if the Workflow already exists. - -**--id-conflict-policy** _string-enum_ - -Determines how to resolve a conflict when spawning a new Workflow Execution with a particular Workflow Id used by an existing Open Workflow Execution. Accepted values: Fail, UseExisting, TerminateExisting. - -**--id-reuse-policy** _string-enum_ - -Re-use policy for the Workflow ID in new Workflow Executions. Accepted values: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. - -**--input**, **-i** _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** _bool_ - -Assume inputs are base64-encoded and attempt to decode them. - -**--input-file** _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** _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. - -**--memo** _string[]_ - -Memo using 'KEY="VALUE"' pairs. Use JSON values. - -**--run-id**, **-r** _string_ - -Run ID. If unset, looks for an Update against the currently-running Workflow Execution. - -**--run-timeout** _duration_ - -Fail a Workflow Run if it lasts longer than `DURATION`. - -**--search-attribute** _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. - -**--start-delay** _duration_ - -Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. - -**--static-details** _string_ - -Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. - -:::note - -Option is experimental. - -::: - -**--static-summary** _string_ - -Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. - -:::note - -Option is experimental. - -::: - -**--task-queue**, **-t** _string_ - -Workflow Task queue. Required. - -**--task-timeout** _duration_ - -Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") - -**--type** _string_ - -Workflow Type name. Required. - -**--update-first-execution-run-id** _string_ - -Parent Run ID. The update is sent to the last Workflow Execution in the chain started with this Run ID. - -**--update-id** _string_ - -Update ID. If unset, defaults to a UUID. - -**--update-input** _string[]_ - -Update input value. Use JSON content or set --update-input-meta to override. Can't be combined with --update-input-file. Can be passed multiple times to pass multiple arguments. - -**--update-input-base64** _bool_ - -Assume update inputs are base64-encoded and attempt to decode them. - -**--update-input-file** _string[]_ - -A path or paths for input file(s). Use JSON content or set --update-input-meta to override. Can't be combined with --update-input. Can be passed multiple times to pass multiple arguments. - -**--update-input-meta** _string[]_ - -Input update payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. - -**--update-name** _string_ - -Update name. Required. - -**--workflow-id**, **-w** _string_ - -Workflow ID. If not supplied, the Service generates a unique ID. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## fix-history-json - -Reserialize an Event History JSON file: - -``` -temporal workflow fix-history-json \ - --source /path/to/original.json \ - --target /path/to/reserialized.json -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--source**, **-s** _string_ - -Path to the original file. Required. - -**--target**, **-t** _string_ - -Path to the results file. When omitted, output is sent to stdout. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## list - -List Workflow Executions. The optional `--query` limits the output to -Workflows matching a Query: - -``` -temporal workflow list \ - --query YourQuery` -``` - -Visit https://docs.temporal.io/visibility to read more about Search Attributes -and Query creation. See `temporal batch --help` for a quick reference. - -View a list of archived Workflow Executions: - -``` -temporal workflow list \ - --archived -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--archived** _bool_ - -Limit output to archived Workflow Executions. - -:::note - -Option is experimental. - -::: - -**--limit** _int_ - -Maximum number of Workflow Executions to display. - -**--page-size** _int_ - -Maximum number of Workflow Executions to fetch at a time from the server. - -**--query**, **-q** _string_ - -Content for an SQL-like `QUERY` List Filter. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## metadata - -Issue a Query for and display user-set metadata like summary and -details for a specific Workflow Execution: - -``` -temporal workflow metadata \ - --workflow-id YourWorkflowId -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--reject-condition** _string-enum_ - -Optional flag for rejecting Queries based on Workflow state. Accepted values: not_open, not_completed_cleanly. - -**--run-id**, **-r** _string_ - -Run ID. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## query - -Send a Query to a Workflow Execution by Workflow ID to retrieve its state. -This synchronous operation exposes the internal state of a running Workflow -Execution, which constantly changes. You can query both running and completed -Workflow Executions: - -``` -temporal workflow query \ - --workflow-id YourWorkflowId - --type YourQueryType - --input '{"YourInputKey": "YourInputValue"}' -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--input**, **-i** _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** _bool_ - -Assume inputs are base64-encoded and attempt to decode them. - -**--input-file** _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** _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. - -**--name** _string_ - -Query Type/Name. Required. - -**--reject-condition** _string-enum_ - -Optional flag for rejecting Queries based on Workflow state. Accepted values: not_open, not_completed_cleanly. - -**--run-id**, **-r** _string_ - -Run ID. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## reset - -Reset a Workflow Execution so it can resume from a point in its Event History -without losing its progress up to that point: - -``` -temporal workflow reset \ - --workflow-id YourWorkflowId \ - --event-id YourLastEvent -``` - -Start from where the Workflow Execution last continued as new: - -``` -temporal workflow reset \ - --workflow-id YourWorkflowId \ - --type LastContinuedAsNew -``` - -For batch resets, limit your resets to FirstWorkflowTask, LastWorkflowTask, or -BuildId. Do not use Workflow IDs, run IDs, or event IDs with this command. - -Visit https://docs.temporal.io/visibility to read more about Search -Attributes and Query creation. - -### with-workflow-update-options - -Run Workflow Update Options atomically after the Workflow is reset. -Workflows selected by the reset command are forwarded onto the subcommand. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--versioning-override-behavior** _string-enum_ - -Override the versioning behavior of a Workflow. Required. Accepted values: pinned, auto_upgrade. - -**--versioning-override-build-id** _string_ - -When overriding to a `pinned` behavior, specifies the Build ID of the version to target. - -**--versioning-override-deployment-name** _string_ - -When overriding to a `pinned` behavior, specifies the Deployment Name of the version to target. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## result - -Wait for and print the result of a Workflow Execution: - -``` -temporal workflow result \ - --workflow-id YourWorkflowId -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--run-id**, **-r** _string_ - -Run ID. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## show - -Show a Workflow Execution's Event History. -When using JSON output (`--output json`), you may pass the results to an SDK -to perform a replay: - -``` -temporal workflow show \ - --workflow-id YourWorkflowId - --output json -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--detailed** _bool_ - -Display events as detailed sections instead of table. Does not apply to JSON output. - -**--follow**, **-f** _bool_ - -Follow the Workflow Execution progress in real time. Does not apply to JSON output. - -**--run-id**, **-r** _string_ - -Run ID. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## signal - -Send an asynchronous notification (Signal) to a running Workflow Execution by -its Workflow ID. The Signal is written to the History. When you include -`--input`, that data is available for the Workflow Execution to consume: - -``` -temporal workflow signal \ - --workflow-id YourWorkflowId \ - --name YourSignal \ - --input '{"YourInputKey": "YourInputValue"}' -``` - -Visit https://docs.temporal.io/visibility to read more about Search Attributes -and Query creation. See `temporal batch --help` for a quick reference. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--input**, **-i** _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** _bool_ - -Assume inputs are base64-encoded and attempt to decode them. - -**--input-file** _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** _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. - -**--name** _string_ - -Signal name. Required. - -**--query**, **-q** _string_ - -Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. - -**--reason** _string_ - -Reason for batch operation. Only use with --query. Defaults to user name. - -**--rps** _float_ - -Limit batch's requests per second. Only allowed if query is present. - -**--run-id**, **-r** _string_ - -Run ID. Only use with --workflow-id. Cannot use with --query. - -**--workflow-id**, **-w** _string_ - -Workflow ID. You must set either --workflow-id or --query. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm signaling. Only allowed when --query is present. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## signal-with-start - -Send an asynchronous notification (Signal) to a Workflow Execution. -If the Workflow Execution is not running or is not found, it starts the -workflow then sends the signal. - -``` -temporal workflow signal-with-start \ - --signal-name YourSignal \ - --signal-input '{"some-key": "some-value"}' \ - --workflow-id YourWorkflowId \ - --type YourWorkflowType \ - --task-queue YourTaskQueue \ - --input '{"some-key": "some-value"}' -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--cron** _string_ - -Cron schedule for the Workflow. - -**--execution-timeout** _duration_ - -Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. - -**--fail-existing** _bool_ - -Fail if the Workflow already exists. - -**--id-conflict-policy** _string-enum_ - -Determines how to resolve a conflict when spawning a new Workflow Execution with a particular Workflow Id used by an existing Open Workflow Execution. Accepted values: Fail, UseExisting, TerminateExisting. - -**--id-reuse-policy** _string-enum_ - -Re-use policy for the Workflow ID in new Workflow Executions. Accepted values: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. - -**--input**, **-i** _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** _bool_ - -Assume inputs are base64-encoded and attempt to decode them. - -**--input-file** _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** _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. - -**--memo** _string[]_ - -Memo using 'KEY="VALUE"' pairs. Use JSON values. - -**--run-timeout** _duration_ - -Fail a Workflow Run if it lasts longer than `DURATION`. - -**--search-attribute** _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. - -**--signal-input** _string[]_ - -Signal input value. Use JSON content or set --signal-input-meta to override. Can't be combined with --signal-input-file. Can be passed multiple times to pass multiple arguments. - -**--signal-input-base64** _bool_ - -Assume signal inputs are base64-encoded and attempt to decode them. - -**--signal-input-file** _string[]_ - -A path or paths for input file(s). Use JSON content or set --signal-input-meta to override. Can't be combined with --signal-input. Can be passed multiple times to pass multiple arguments. - -**--signal-input-meta** _string[]_ - -Input signal payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. - -**--signal-name** _string_ - -Signal name. Required. - -**--start-delay** _duration_ - -Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. - -**--static-details** _string_ - -Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. - -:::note - -Option is experimental. - -::: - -**--static-summary** _string_ - -Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. - -:::note - -Option is experimental. - -::: - -**--task-queue**, **-t** _string_ - -Workflow Task queue. Required. - -**--task-timeout** _duration_ - -Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") - -**--type** _string_ - -Workflow Type name. Required. - -**--workflow-id**, **-w** _string_ - -Workflow ID. If not supplied, the Service generates a unique ID. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## stack - -Perform a Query on a Workflow Execution using a `__stack_trace`-type Query. -Display a stack trace of the threads and routines currently in use by the -Workflow for troubleshooting: - -``` -temporal workflow stack \ - --workflow-id YourWorkflowId -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--reject-condition** _string-enum_ - -Optional flag to reject Queries based on Workflow state. Accepted values: not_open, not_completed_cleanly. - -**--run-id**, **-r** _string_ - -Run ID. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## start - -Start a new Workflow Execution. Returns the Workflow- and Run-IDs: - -``` -temporal workflow start \ - --workflow-id YourWorkflowId \ - --type YourWorkflow \ - --task-queue YourTaskQueue \ - --input '{"some-key": "some-value"}' -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--cron** _string_ - -Cron schedule for the Workflow. - -**--execution-timeout** _duration_ - -Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. - -**--fail-existing** _bool_ - -Fail if the Workflow already exists. - -**--id-conflict-policy** _string-enum_ - -Determines how to resolve a conflict when spawning a new Workflow Execution with a particular Workflow Id used by an existing Open Workflow Execution. Accepted values: Fail, UseExisting, TerminateExisting. - -**--id-reuse-policy** _string-enum_ - -Re-use policy for the Workflow ID in new Workflow Executions. Accepted values: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. - -**--input**, **-i** _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** _bool_ - -Assume inputs are base64-encoded and attempt to decode them. - -**--input-file** _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** _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. - -**--memo** _string[]_ - -Memo using 'KEY="VALUE"' pairs. Use JSON values. - -**--run-timeout** _duration_ - -Fail a Workflow Run if it lasts longer than `DURATION`. - -**--search-attribute** _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. - -**--start-delay** _duration_ - -Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. - -**--static-details** _string_ - -Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. - -:::note - -Option is experimental. - -::: - -**--static-summary** _string_ - -Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. - -:::note - -Option is experimental. - -::: - -**--task-queue**, **-t** _string_ - -Workflow Task queue. Required. - -**--task-timeout** _duration_ - -Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") - -**--type** _string_ - -Workflow Type name. Required. - -**--workflow-id**, **-w** _string_ - -Workflow ID. If not supplied, the Service generates a unique ID. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## start-update-with-start - -Send a message to a Workflow Execution to invoke an Update handler, and wait for -the update to be accepted or rejected. If the Workflow Execution is not running, -then a new workflow execution is started and the update is sent. - -Experimental. - -``` -temporal workflow start-update-with-start \ - --update-name YourUpdate \ - --update-input '{"update-key": "update-value"}' \ - --update-wait-for-stage accepted \ - --workflow-id YourWorkflowId \ - --type YourWorkflowType \ - --task-queue YourTaskQueue \ - --id-conflict-policy Fail \ - --input '{"wf-key": "wf-value"}' -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--cron** _string_ - -Cron schedule for the Workflow. - -**--execution-timeout** _duration_ - -Fail a WorkflowExecution if it lasts longer than `DURATION`. This time-out includes retries and ContinueAsNew tasks. - -**--fail-existing** _bool_ - -Fail if the Workflow already exists. - -**--id-conflict-policy** _string-enum_ - -Determines how to resolve a conflict when spawning a new Workflow Execution with a particular Workflow Id used by an existing Open Workflow Execution. Accepted values: Fail, UseExisting, TerminateExisting. - -**--id-reuse-policy** _string-enum_ - -Re-use policy for the Workflow ID in new Workflow Executions. Accepted values: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning. - -**--input**, **-i** _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** _bool_ - -Assume inputs are base64-encoded and attempt to decode them. - -**--input-file** _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** _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. - -**--memo** _string[]_ - -Memo using 'KEY="VALUE"' pairs. Use JSON values. - -**--run-id**, **-r** _string_ - -Run ID. If unset, looks for an Update against the currently-running Workflow Execution. - -**--run-timeout** _duration_ - -Fail a Workflow Run if it lasts longer than `DURATION`. - -**--search-attribute** _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. - -**--start-delay** _duration_ - -Delay before starting the Workflow Execution. Can't be used with cron schedules. If the Workflow receives a signal or update prior to this time, the Workflow Execution starts immediately. - -**--static-details** _string_ - -Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. - -:::note - -Option is experimental. - -::: - -**--static-summary** _string_ - -Static Workflow summary for human consumption in UIs. Uses Temporal Markdown formatting, should be a single line. - -:::note - -Option is experimental. - -::: - -**--task-queue**, **-t** _string_ - -Workflow Task queue. Required. - -**--task-timeout** _duration_ - -Fail a Workflow Task if it lasts longer than `DURATION`. This is the Start-to-close timeout for a Workflow Task. (default "10s") - -**--type** _string_ - -Workflow Type name. Required. - -**--update-first-execution-run-id** _string_ - -Parent Run ID. The update is sent to the last Workflow Execution in the chain started with this Run ID. - -**--update-id** _string_ - -Update ID. If unset, defaults to a UUID. - -**--update-input** _string[]_ - -Update input value. Use JSON content or set --update-input-meta to override. Can't be combined with --update-input-file. Can be passed multiple times to pass multiple arguments. - -**--update-input-base64** _bool_ - -Assume update inputs are base64-encoded and attempt to decode them. - -**--update-input-file** _string[]_ - -A path or paths for input file(s). Use JSON content or set --update-input-meta to override. Can't be combined with --update-input. Can be passed multiple times to pass multiple arguments. - -**--update-input-meta** _string[]_ - -Input update payload metadata as a `KEY=VALUE` pair. When the KEY is "encoding", this overrides the default ("json/plain"). Can be passed multiple times. - -**--update-name** _string_ - -Update name. Required. - -**--update-wait-for-stage** _string-enum_ - -Update stage to wait for. The only option is `accepted`, but this option is required. This is to allow a future version of the CLI to choose a default value. Required. Accepted values: accepted. - -**--workflow-id**, **-w** _string_ - -Workflow ID. If not supplied, the Service generates a unique ID. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## terminate - -Terminate a Workflow Execution: - -``` -temporal workflow terminate \ - --reason YourReasonForTermination \ - --workflow-id YourWorkflowId -``` - -The reason is optional and defaults to the current user's name. The reason -is stored in the Event History as part of the `WorkflowExecutionTerminated` -event. This becomes the closing Event in the Workflow Execution's history. - -Executions may be terminated in bulk via a visibility Query list filter: - -``` -temporal workflow terminate \ - --query YourQuery \ - --reason YourReasonForTermination -``` - -Workflow code cannot see or respond to terminations. To perform clean-up work -in your Workflow code, use `temporal workflow cancel` instead. - -Visit https://docs.temporal.io/visibility to read more about Search Attributes -and Query creation. See `temporal batch --help` for a quick reference. - -Use the following options to change the behavior of this command. - -**Flags:** - -**--query**, **-q** _string_ - -Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. - -**--reason** _string_ - -Reason for termination. Defaults to message with the current user's name. - -**--rps** _float_ - -Limit batch's requests per second. Only allowed if query is present. - -**--run-id**, **-r** _string_ - -Run ID. Can only be set with --workflow-id. Do not use with --query. - -**--workflow-id**, **-w** _string_ - -Workflow ID. You must set either --workflow-id or --query. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm termination. Can only be used with --query. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## trace - -Display the progress of a Workflow Execution and its child workflows with a -real-time trace. This view helps you understand how Workflows are proceeding: - -``` -temporal workflow trace \ - --workflow-id YourWorkflowId -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--concurrency** _int_ - -Number of Workflow Histories to fetch at a time. (default "10") - -**--depth** _int_ - -Set depth for your Child Workflow fetches. Pass -1 to fetch child workflows at any depth. (default "-1") - -**--fold** _string[]_ - -Fold away Child Workflows with the specified statuses. Case-insensitive. Ignored if --no-fold supplied. Available values: running, completed, failed, canceled, terminated, timedout, continueasnew. Can be passed multiple times. - -**--no-fold** _bool_ - -Disable folding. Fetch and display Child Workflows within the set depth. - -**--run-id**, **-r** _string_ - -Run ID. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## update - -An Update is a synchronous call to a Workflow Execution that can change its -state, control its flow, and return a result. - -### describe - -Given a Workflow Execution and an Update ID, return information about its current status, including -a result if it has finished. - -``` -temporal workflow update describe \ - --workflow-id YourWorkflowId \ - --update-id YourUpdateId -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--run-id**, **-r** _string_ - -Run ID. If unset, updates the currently-running Workflow Execution. - -**--update-id** _string_ - -Update ID. Must be unique per Workflow Execution. Required. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### execute - -Send a message to a Workflow Execution to invoke an Update handler, and wait for -the update to complete or fail. You can also use this to wait for an existing -update to complete, by submitting an existing update ID. - -``` -temporal workflow update execute \ - --workflow-id YourWorkflowId \ - --name YourUpdate \ - --input '{"some-key": "some-value"}' -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--first-execution-run-id** _string_ - -Parent Run ID. The update is sent to the last Workflow Execution in the chain started with this Run ID. - -**--input**, **-i** _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** _bool_ - -Assume inputs are base64-encoded and attempt to decode them. - -**--input-file** _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** _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. - -**--name** _string_ - -Handler method name. Required. - -**--run-id**, **-r** _string_ - -Run ID. If unset, looks for an Update against the currently-running Workflow Execution. - -**--update-id** _string_ - -Update ID. If unset, defaults to a UUID. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### result - -Given a Workflow Execution and an Update ID, wait for the Update to complete or fail and -print the result. - -``` -temporal workflow update result \ - --workflow-id YourWorkflowId \ - --update-id YourUpdateId -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--run-id**, **-r** _string_ - -Run ID. If unset, updates the currently-running Workflow Execution. - -**--update-id** _string_ - -Update ID. Must be unique per Workflow Execution. Required. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -### start - -Send a message to a Workflow Execution to invoke an Update handler, and wait for -the update to be accepted or rejected. You can subsequently wait for the update -to complete by using `temporal workflow update execute`. - -``` -temporal workflow update start \ - --workflow-id YourWorkflowId \ - --name YourUpdate \ - --input '{"some-key": "some-value"}' - --wait-for-stage accepted -``` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--first-execution-run-id** _string_ - -Parent Run ID. The update is sent to the last Workflow Execution in the chain started with this Run ID. - -**--input**, **-i** _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** _bool_ - -Assume inputs are base64-encoded and attempt to decode them. - -**--input-file** _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** _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. - -**--name** _string_ - -Handler method name. Required. - -**--run-id**, **-r** _string_ - -Run ID. If unset, looks for an Update against the currently-running Workflow Execution. - -**--update-id** _string_ - -Update ID. If unset, defaults to a UUID. - -**--wait-for-stage** _string-enum_ - -Update stage to wait for. The only option is `accepted`, but this option is required. This is to allow a future version of the CLI to choose a default value. Required. Accepted values: accepted. - -**--workflow-id**, **-w** _string_ - -Workflow ID. Required. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - -## update-options - -+---------------------------------------------------------------------+ -| CAUTION: Worflow update-options is experimental. Workflow Execution | -| properties are subject to change. | -+---------------------------------------------------------------------+ - -Modify properties of Workflow Executions: - -``` -temporal workflow update-options [options] -``` - -It can override the Worker Deployment configuration of a -Workflow Execution, which controls Worker Versioning. - -For example, to force Workers in the current Deployment execute the -next Workflow Task change behavior to `auto_upgrade`: - -``` -temporal workflow update-options \ - --workflow-id YourWorkflowId \ - --versioning-override-behavior auto_upgrade -``` - -or to pin the workflow execution to a Worker Deployment, set behavior -to `pinned`: - -``` -temporal workflow update-options \ - --workflow-id YourWorkflowId \ - --versioning-override-behavior pinned \ - --versioning-override-deployment-name YourDeploymentName \ - --versioning-override-build-id YourDeploymentBuildId -``` - -To remove any previous overrides, set the behavior to -`unspecified`: - -``` -temporal workflow update-options \ - --workflow-id YourWorkflowId \ - --versioning-override-behavior unspecified -``` - -To see the current override use `temporal workflow describe` - -Use the following options to change the behavior of this command. - -**Flags:** - -**--query**, **-q** _string_ - -Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. - -**--reason** _string_ - -Reason for batch operation. Only use with --query. Defaults to user name. - -**--rps** _float_ - -Limit batch's requests per second. Only allowed if query is present. - -**--run-id**, **-r** _string_ - -Run ID. Only use with --workflow-id. Cannot use with --query. - -**--versioning-override-behavior** _string-enum_ - -Override the versioning behavior of a Workflow. Required. Accepted values: unspecified, pinned, auto_upgrade. - -**--versioning-override-build-id** _string_ - -When overriding to a `pinned` behavior, specifies the Build ID of the version to target. - -**--versioning-override-deployment-name** _string_ - -When overriding to a `pinned` behavior, specifies the Deployment Name of the version to target. - -**--workflow-id**, **-w** _string_ - -Workflow ID. You must set either --workflow-id or --query. - -**--yes**, **-y** _bool_ - -Don't prompt to confirm signaling. Only allowed when --query is present. - -**Global Flags:** - -**--address** _string_ - -Temporal Service gRPC endpoint. (default "127.0.0.1:7233") - -**--api-key** _string_ - -API key for request. - -**--client-connect-timeout** _duration_ - -The client connection timeout. 0s means no timeout. - -**--codec-auth** _string_ - -Authorization header for Codec Server requests. - -**--codec-endpoint** _string_ - -Remote Codec Server endpoint. - -**--codec-header** _string[]_ - -HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. - -**--color** _string-enum_ - -Output coloring. Accepted values: always, never, auto. (default "auto") - -**--command-timeout** _duration_ - -The command execution timeout. 0s means no timeout. - -**--config-file** _string_ - -File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, "$HOME/Library/Application Support" on macOS, and %AppData% on Windows. - -:::note - -Option is experimental. - -::: - -**--disable-config-env** _bool_ - -If set, disables loading environment config from environment variables. - -:::note - -Option is experimental. - -::: - -**--disable-config-file** _bool_ - -If set, disables loading environment config from config file. - -:::note - -Option is experimental. - -::: - -**--env** _string_ - -Active environment name (`ENV`). (default "default") - -**--env-file** _string_ - -Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. - -**--grpc-authority** _string_ - -Temporal gRPC client :authority pseudoheader. - -**--grpc-meta** _string[]_ - -HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. - -**--log-format** _string-enum_ - -Log format. Accepted values: text, json. (default "text") - -**--log-level** _string-enum_ - -Log level. Default is "info" for most commands and "warn" for `server start-dev`. Accepted values: debug, info, warn, error, never. (default "info") - -**--namespace**, **-n** _string_ - -Temporal Service Namespace. (default "default") - -**--no-json-shorthand-payloads** _bool_ - -Raw payload output, even if the JSON option was used. - -**--output**, **-o** _string-enum_ - -Non-logging data output format. Accepted values: text, json, jsonl, none. (default "text") - -**--profile** _string_ - -Profile to use for config file. - -:::note - -Option is experimental. - -::: - -**--time-format** _string-enum_ - -Time format. Accepted values: relative, iso, raw. (default "relative") - -**--tls** _bool_ - -Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. - -**--tls-ca-data** _string_ - -Data for server CA certificate. Can't be used with --tls-ca-path. - -**--tls-ca-path** _string_ - -Path to server CA certificate. Can't be used with --tls-ca-data. - -**--tls-cert-data** _string_ - -Data for x509 certificate. Can't be used with --tls-cert-path. - -**--tls-cert-path** _string_ - -Path to x509 certificate. Can't be used with --tls-cert-data. - -**--tls-disable-host-verification** _bool_ - -Disable TLS host-name verification. - -**--tls-key-data** _string_ - -Private certificate key data. Can't be used with --tls-key-path. - -**--tls-key-path** _string_ - -Path to x509 private key. Can't be used with --tls-key-data. - -**--tls-server-name** _string_ - -Override target TLS server name. - From 0762231fe64a4fcbab450443fcbfd29cfd0ea051 Mon Sep 17 00:00:00 2001 From: Will Charczuk Date: Wed, 27 Aug 2025 13:34:42 -0700 Subject: [PATCH 10/10] just making it --client --- temporalcli/client.go | 4 ++-- temporalcli/commands.gen.go | 4 ++-- temporalcli/commandsgen/commands.yml | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/temporalcli/client.go b/temporalcli/client.go index 5d7b14641..d03c2277e 100644 --- a/temporalcli/client.go +++ b/temporalcli/client.go @@ -173,8 +173,8 @@ func (c *ClientOptions) dialClient(cctx *CommandContext) (client.Client, error) return nil, fmt.Errorf("failed creating client options: %w", err) } - if c.GrpcAuthority != "" { - clientOptions.ConnectionOptions.Authority = c.GrpcAuthority + if c.ClientAuthority != "" { + clientOptions.ConnectionOptions.Authority = c.ClientAuthority } clientOptions.Logger = log.NewStructuredLogger(cctx.Logger) diff --git a/temporalcli/commands.gen.go b/temporalcli/commands.gen.go index 90e36339a..2cd5e8da2 100644 --- a/temporalcli/commands.gen.go +++ b/temporalcli/commands.gen.go @@ -18,7 +18,7 @@ var hasHighlighting = isatty.IsTerminal(os.Stdout.Fd()) type ClientOptions struct { Address string - GrpcAuthority string + ClientAuthority string Namespace string ApiKey string GrpcMeta []string @@ -38,7 +38,7 @@ type ClientOptions struct { func (v *ClientOptions) buildFlags(cctx *CommandContext, f *pflag.FlagSet) { f.StringVar(&v.Address, "address", "127.0.0.1:7233", "Temporal Service gRPC endpoint.") - f.StringVar(&v.GrpcAuthority, "grpc-authority", "", "Temporal gRPC client :authority pseudoheader.") + f.StringVar(&v.ClientAuthority, "client-authority", "", "Temporal gRPC client :authority pseudoheader.") f.StringVarP(&v.Namespace, "namespace", "n", "default", "Temporal Service Namespace.") f.StringVar(&v.ApiKey, "api-key", "", "API key for request.") f.StringArrayVar(&v.GrpcMeta, "grpc-meta", nil, "HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`.") diff --git a/temporalcli/commandsgen/commands.yml b/temporalcli/commandsgen/commands.yml index 9eb3ea9c9..e63f7a7e9 100644 --- a/temporalcli/commandsgen/commands.yml +++ b/temporalcli/commandsgen/commands.yml @@ -4051,7 +4051,7 @@ option-sets: description: Temporal Service gRPC endpoint. default: 127.0.0.1:7233 implied-env: TEMPORAL_ADDRESS - - name: grpc-authority + - name: client-authority type: string description: Temporal gRPC client :authority pseudoheader. - name: namespace