temporal operator namespace update flags
The `temporal operator namespace update` command accepts the following flags: `--namespace` (required, string), `--active-cluster` (string), `--cluster` (string array), `--data` (string array, KEY=VALUE pairs), `--description` (string), `--email` (string), `--history-archival-state` (string-enum: disabled, enabled), `--history-uri` (string), `--promote-global` (bool), `--replication-state` (string-enum: normal, handover), `--retention` (duration), `--visibility-archival-state` (string-enum: disabled, enabled), `--visibility-uri` (string). URI values for archival states cannot be changed once enabled.
temporal operator nexus endpoint get flags
The `temporal operator nexus endpoint get` command accepts the following required flag: `--name` (string) specifying the endpoint name.
temporal schedule delete flags
The `temporal schedule delete` command has the following flags: `--schedule-id` or `-s` (required, string) for Schedule ID.
temporal schedule backfill command
The `temporal schedule backfill` command batch-executes actions that would have run during a specified time interval. It is used 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 is best to use the BufferAll or AllowAll policies to avoid conflicts and ensure no Workflow Executions are skipped.
temporal schedule backfill flags
The `temporal schedule backfill` command has the following flags: `--end-time` (required, timestamp) for backfill end time; `--overlap-policy` (optional, string-enum with values: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll) for policy handling overlapping Workflow Executions; `--schedule-id` or `-s` (required, string) for Schedule ID; `--start-time` (required, timestamp) for backfill start time.
overlap policies for Schedule backfill
The overlap policies for Schedule backfill are: AllowAll (allow unlimited concurrent Workflow Executions, significantly speeds up backfilling on systems supporting concurrency, must ensure running Executions do not interfere); BufferAll (buffer all incoming Workflow Executions while waiting for running Execution to complete); Skip (if previous Workflow Execution still running, discard new Executions); BufferOne (same as Skip but buffer a single Workflow Execution to run after previous Execution completes, discard others); CancelOther (cancel running Workflow Execution and replace with incoming new Execution); TerminateOther (terminate running Workflow Execution and replace with incoming new Execution).
temporal schedule create command
The `temporal schedule create` command creates a new Schedule on the Temporal Service that automatically starts new Workflow Executions at the times specified. Schedules support any combination of `--calendar`, `--interval`, and `--cron` for specifying timing.
temporal schedule create timing specifications
The `temporal schedule create` command supports three timing specification formats: shorthand `--interval` strings (e.g., 45m for every 45 minutes, or 6h/5m for every 6 hours at the top of the 5th hour); JSON `--calendar` specifications (e.g., {"dayOfWeek":"Fri","hour":"3","minute":"30"}); Unix-style `--cron` strings and robfig declarations (@daily/@weekly/@every X/etc, e.g., every Friday at 12:30 PM: `30 12 * * Fri`).
temporal schedule create flags
The `temporal schedule create` command has the following flags: `--calendar` (optional, string[]) for JSON calendar specification; `--catchup-window` (optional, duration) for maximum catch-up time when service unavailable; `--cron` (optional, string[]) for cron format specification; `--end-time` (optional, timestamp) for schedule end time; `--execution-timeout` (optional, duration) to fail WorkflowExecution if longer than DURATION (includes retries and ContinueAsNew); `--fairness-key` (optional, string, max 64 bytes) for proportional task dispatch; `--fairness-weight` (optional, float 0.001-1000) for weight of fairness key; `--headers` (optional, string[], KEY=VALUE format) for workflow headers; `--input` or `-i` (optional, string[]) for input value; `--input-base64` (optional, bool) to decode base64 inputs; `--input-file` (optional, string[]) for input file paths; `--input-meta` (optional, string[], KEY=VALUE) for input payload metadata; `--interval` (optional, string[]) for interval duration; `--jitter` (optional, duration) for max time variation; `--memo` (optional, string[], KEY="VALUE") for memo with JSON values; `--notes` (optional, string) for initial notes field; `--overlap-policy` (optional, string-enum: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll); `--pause-on-failure` (optional, bool) to pause after failures; `--paused` (optional, bool) to pause on creation; `--priority-key` (optional, int 1-5, default 3, lower = higher priority); `--remaining-actions` (optional, int, default 0 for unlimited) for total allowed actions; `--run-timeout` (optional, duration) to fail if Workflow Run longer than DURATION; `--schedule-id` or `-s` (required, string); `--schedule-memo` (optional, string[], KEY="VALUE") for schedule memo; `--schedule-search-attribute` (optional, string[], KEY="VALUE") for schedule search attributes; `--search-attribute` (optional, string[], KEY=VALUE) for workflow search attributes; `--start-time` (optional, timestamp); `--static-details` (optional, string, Temporal Markdown, experimental) for static workflow details; `--static-summary` (optional, string, single line Temporal Markdown, experimental) for static workflow summary; `--task-queue` or `-t` (required, string) for workflow task queue; `--task-timeout` (optional, duration) for workflow task start-to-close timeout; `--time-zone` (optional, string) to interpret calendar specs with TZ time zone; `--type` (required, string) for workflow type name; `--workflow-id` or `-w` (optional, string) for workflow ID (service generates if not supplied).
temporal schedule delete command
The `temporal schedule delete` command deletes a Schedule on the front end Service. Removing a Schedule will not affect 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.
temporal schedule describe command
The `temporal schedule describe` command shows a Schedule configuration, including information about past, current, and future Workflow runs.
temporal schedule describe flags
The `temporal schedule describe` command has the following flags: `--schedule-id` or `-s` (required, string) for Schedule ID.
temporal schedule list command
The `temporal schedule list` command lists the Schedules hosted by a Namespace.
temporal schedule list flags
The `temporal schedule list` command has the following flags: `--long` or `-l` (optional, bool) to show detailed information; `--query` or `-q` (optional, string) to filter results using given List Filter; `--really-long` (optional, bool) to show extensive information in non-table form.
temporal schedule list-matching-times command
The `temporal schedule list-matching-times` command lists the times a Schedule's spec would match within a given time range. The time range may be in the past or future. Use this command to preview when a Schedule will take actions without actually running them. This is an experimental feature and may change in the future.
temporal schedule list-matching-times flags
The `temporal schedule list-matching-times` command has the following flags: `--end-time` (required, timestamp) for end of time range to list matching times; `--schedule-id` or `-s` (required, string) for Schedule ID; `--start-time` (required, timestamp) for start of time range to list matching times.
temporal schedule toggle command
The `temporal schedule toggle` command pauses or unpauses a Schedule by passing a flag with the desired state. 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.
temporal schedule toggle flags
The `temporal schedule toggle` command has the following flags: `--pause` (optional, bool) to pause the Schedule; `--reason` (optional, string) for reason for pausing or unpausing the Schedule; `--schedule-id` or `-s` (required, string) for Schedule ID; `--unpause` (optional, bool) to unpause the Schedule.
temporal schedule trigger command
The `temporal schedule trigger` command triggers a Schedule to run immediately.
temporal schedule trigger flags
The `temporal schedule trigger` command has the following flags: `--overlap-policy` (optional, string-enum with values: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll) for policy handling overlapping Workflow Executions; `--schedule-id` or `-s` (required, string) for Schedule ID.
temporal schedule update command
The `temporal schedule update` command updates an existing Schedule with new configuration details, including time specifications, action, and policies. This command performs a full replacement of the Schedule configuration. Any options not provided will be reset to their default values. You must re-specify all options, not just the ones you want to change. To view the current configuration of a Schedule, use `temporal schedule describe` before updating. Schedule memo and search attributes cannot be updated with this command. They are set only during Schedule creation and are not affected by updates.
temporal schedule update flags
The `temporal schedule update` command has the same flags as `temporal schedule create`: `--calendar` (optional, string[]); `--catchup-window` (optional, duration); `--cron` (optional, string[]); `--end-time` (optional, timestamp); `--execution-timeout` (optional, duration); `--fairness-key` (optional, string, max 64 bytes); `--fairness-weight` (optional, float 0.001-1000); `--headers` (optional, string[]); `--input` or `-i` (optional, string[]); `--input-base64` (optional, bool); `--input-file` (optional, string[]); `--input-meta` (optional, string[]); `--interval` (optional, string[]); `--jitter` (optional, duration); `--memo` (optional, string[]); `--notes` (optional, string); `--overlap-policy` (optional, string-enum: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll); `--pause-on-failure` (optional, bool); `--paused` (optional, bool); `--priority-key` (optional, int 1-5, default 3); `--remaining-actions` (optional, int); `--run-timeout` (optional, duration); `--schedule-id` or `-s` (required, string); `--search-attribute` (optional, string[]); `--start-time` (optional, timestamp); `--static-details` (optional, string, experimental); `--static-summary` (optional, string, experimental); `--task-queue` or `-t` (required, string); `--task-timeout` (optional, duration); `--time-zone` (optional, string); `--type` (required, string); `--workflow-id` or `-w` (optional, string).
start-dev flag: --ui-disable-news-fetch disables Web UI newsfeed
The `--ui-disable-news-fetch` flag is a boolean that disables the Web UI newsfeed. When set, the UI will not request the newsfeed and the button to open the newsfeed panel is hidden. This flag is not required.
start-dev flag: --ui-public-path sets Web UI public base path
The `--ui-public-path` flag accepts a string and sets the public base path for the Web UI. It defaults to `/`. This flag is not required.
start-dev flag: --sqlite-pragma for SQLite pragma statements
The `--sqlite-pragma` flag accepts string array values in "PRAGMA=VALUE" format. This flag is not required and can be passed multiple times.
Global flag: --namespace specifies default namespace
The `--namespace` or `-n` global flag accepts a string specifying the Temporal Service Namespace. It defaults to `default`. This flag is not required and applies to all commands.
start-dev flag: --db-filename for persistent state
The `--db-filename` or `-f` flag accepts a string path to a file for persistent Temporal state store. By default, Workflow Executions are lost when the server process dies. This flag is not required.
start-dev flag: --headless disables Web UI
The `--headless` flag is a boolean that disables the Web UI. This flag is not required.
Global flag: --no-json-shorthand-payloads for raw payload output
The `--no-json-shorthand-payloads` global flag is a boolean that enables raw payload output, even if the JSON option was used. This flag is not required and applies to all commands.
start-dev flag: --ui-port for Web UI port
The `--ui-port` flag accepts an integer and sets the port for the Web UI. It defaults to the '--port' value plus 1000 (8233 by default). This flag is not required.
start-dev flag: --port for gRPC service port
The `--port` or `-p` flag accepts an integer and sets the port for the front-end gRPC Service. The default is 7233. This flag is not required.
start-dev flag: --namespace creates namespaces at launch
The `--namespace` or `-n` flag accepts a string array of namespaces to be created at launch. The "default" Namespace is always created automatically. This flag is not required and can be passed multiple times.
start-dev flag: --search-attribute registers search attributes
The `--search-attribute` flag accepts string array values in `KEY=VALUE` pairs format. Keys must be identifiers and values must be the search attribute type: Text, Keyword, Int, Double, Bool, Datetime, or KeywordList. This flag is not required and can be passed multiple times.
start-dev flag: --dynamic-config-value for dynamic configuration
The `--dynamic-config-value` flag accepts string array values using `KEY=VALUE` pairs. Keys must be identifiers and values must be JSON values. This flag is not required and can be passed multiple times.
start-dev flag: --http-port for HTTP API service
The `--http-port` flag accepts an integer and sets the port for the HTTP API service. It defaults to a random free port. This flag is not required.
start-dev flag: --metrics-port for metrics endpoint
The `--metrics-port` flag accepts an integer and sets the port for the '/metrics' HTTP endpoint. It defaults to a random free port. This flag is not required.
start-dev flag: --ip binds service to IP address
The `--ip` flag accepts a string and specifies the IP address bound to the front-end Service. This flag is not required.
start-dev flag: --ui-ip binds Web UI to IP address
The `--ui-ip` flag accepts a string and specifies the IP address bound to the Web UI. It defaults to the same as the '--ip' value. This flag is not required.
start-dev flag: --log-config prints server config
The `--log-config` flag is a boolean that prints the server config to stderr. This flag is not required.
start-dev flag: --ui-asset-path for custom UI assets
The `--ui-asset-path` flag accepts a string path to UI custom assets. This flag is not required.
start-dev flag: --ui-codec-endpoint for UI codec HTTP endpoint
The `--ui-codec-endpoint` flag accepts a string URL for a UI remote codec HTTP endpoint. This flag is not required.
temporal server start-dev command starts local development server
The `temporal server start-dev` command runs a development Temporal Server on your local system. The development server is not intended for production use and skips certain HTTP security checks to make local use simpler. The Web UI is available at http://localhost:8233 by default.
temporal worker list command
Get a list of workers to a specified namespace using `temporal worker list --namespace YourNamespace [options]`. Optional flags: `--limit` (int) - Maximum number of workers to display, `--query`, `-q` (string) - Content for an SQL-like QUERY List Filter.
Current Version receives new workflow tasks
When a Version is set as Current for a Deployment, Workers of that Deployment Version will receive tasks from new Workflows, and from existing AutoUpgrade Workflows that are running on this Deployment.
Ramping Version percentage range
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 do that.
GCP Cloud Run scaling parameters must be set together
For GCP Cloud Run Worker Deployment Versions, the four scaler parameters (--gcp-cloud-run-min-instances, --gcp-cloud-run-max-instances, --gcp-cloud-run-initial-instances, and --gcp-cloud-run-utilization-target) must all be set together. When updating only scaling settings without changing the provider, supply the four scaler flags without the provider fields.
temporal worker deployment create command
Create a new Worker Deployment using `temporal worker deployment create [options]`. Worker Deployments are lazily created the first time a Worker polls the Temporal Server with a VersionOverride, but you can pre-define one with this command to set up a serverless Worker. If a Worker Deployment with the supplied name already exists, the command returns an error. Required flag: `--name`, `-d` (string) - Name for a Worker Deployment.
temporal worker deployment create-version command
Create a new Worker Deployment Version using `temporal worker deployment create-version [options]`. Configure compute provider information for AWS Lambda or GCP Cloud Run. Returns an error if all compute configuration fields are empty. Required flags: `--build-id` (string) - Build ID of the Worker Deployment Version; `--deployment-name` (string) - Name of the Worker Deployment. Optional flags: `--aws-lambda-function-arn` (string), `--aws-lambda-assume-role-arn` (string, required when function-arn is specified), `--aws-lambda-assume-role-external-id` (string, required when function-arn is specified), `--gcp-cloud-run-project` (string, required when worker-pool is specified), `--gcp-cloud-run-region` (string, required when worker-pool is specified), `--gcp-cloud-run-worker-pool` (string), `--gcp-cloud-run-service-account` (string, required when worker-pool is specified), `--gcp-cloud-run-min-instances` (int, defaults to 0), `--gcp-cloud-run-max-instances` (int, defaults to 30), `--gcp-cloud-run-initial-instances` (int, defaults to 0), `--gcp-cloud-run-utilization-target` (float, defaults to 0.8). When setting GCP scaler flags, all four (min, max, initial, utilization-target) must be set together.
temporal worker deployment delete command
Remove a Worker Deployment using `temporal worker deployment delete [options]`. A Deployment can only be deleted if it has no Version in it. Required flag: `--name`, `-d` (string) - Name for a Worker Deployment.
temporal worker deployment delete-version command
Remove a Worker Deployment Version using `temporal worker deployment delete-version [options]`. A Version can only be deleted when all of these conditions are met: it is not the Current or Ramping Version, it has no active pollers on any task queues, and it is not draining (can be ignored with `--skip-drainage`). Required flags: `--deployment-name` (string), `--build-id` (string). Optional flag: `--skip-drainage` (bool) - Ignore the deletion requirement of not draining.
temporal worker deployment describe command
Describe properties of a Worker Deployment using `temporal worker deployment describe [options]`. Returns versions, routing information of new or existing tasks, and creation time. Required flag: `--name`, `-d` (string) - Name for a Worker Deployment.
temporal worker deployment describe-version command
Describe properties of a Worker Deployment Version using `temporal worker deployment describe-version [options]`. Returns task queues polled by workers, drainage information, user-provided metadata, and creation/modification time. Required flags: `--deployment-name` (string), `--build-id` (string). Optional flag: `--report-task-queue-stats` (bool) - Report stats for task queues in this version.
temporal worker deployment list command
List existing Worker Deployments in the client's namespace using `temporal worker deployment list [options]`. Use global flags to customize connection to Temporal Service.
temporal worker deployment manager-identity set command
Set the ManagerIdentity of a Worker Deployment using `temporal worker deployment manager-identity set [options]`. ManagerIdentity is the identity of the user with exclusive right to make changes to the Deployment. When set, users whose identity does not match cannot change the Deployment. Required flag: `--deployment-name` (string). Required flag (one of): `--manager-identity` (string) or `--self` (bool). Optional flags: `--identity` (string, populated by CLI if not provided when using --self), `--yes`, `-y` (bool) - Don't prompt to confirm.
temporal worker deployment manager-identity unset command
Unset the ManagerIdentity of a Worker Deployment using `temporal worker deployment manager-identity unset [options]`. Clears the Manager Identity field for a given Deployment. Required flag: `--deployment-name` (string). Optional flag: `--yes`, `-y` (bool) - Don't prompt to confirm.
temporal worker deployment set-current-version command
Set the Current Version for a Deployment using `temporal worker deployment set-current-version [options]`. When a Version is current, Workers of that Version receive tasks from new Workflows and from existing AutoUpgrade Workflows running on this Deployment. If not all expected Task Queues are being polled, the request fails; use `--ignore-missing-task-queues` to override. Required flag: `--deployment-name` (string). Required flag (one of): `--build-id` (string) or `--unversioned` (bool). Optional flags: `--allow-no-pollers` (bool), `--ignore-missing-task-queues` (bool), `--yes`, `-y` (bool).
temporal worker deployment set-ramping-version command
Set the Ramping Version and Percentage for a Deployment using `temporal worker deployment set-ramping-version [options]`. Ramping Version can be set using build ID or `--unversioned` flag. Ramping Percentage is a float in range [0, 100]; a value of 100 does not make it Current. Use `--delete` to remove a Ramping Version. If not all expected Task Queues are being polled, use `--ignore-missing-task-queues` to override. Required flag: `--deployment-name` (string). Optional flags: `--build-id` (string, required unless --unversioned), `--unversioned` (bool, cannot be used with --build-id), `--percentage` (float, range [0,100]), `--delete` (bool), `--allow-no-pollers` (bool), `--ignore-missing-task-queues` (bool), `--yes`, `-y` (bool).
temporal worker deployment update-version-compute-config command
Update compute configuration of a Worker Deployment Version using `temporal worker deployment update-version-compute-config [options]`. Can update AWS Lambda ARN and role information, or GCP Cloud Run configuration. Use `--remove` to remove all compute configuration. Required flags: `--deployment-name` (string), `--build-id` (string). Optional flags: `--aws-lambda-function-arn` (string), `--aws-lambda-assume-role-arn` (string, required when function-arn specified), `--aws-lambda-assume-role-external-id` (string, required when function-arn specified), `--gcp-cloud-run-project` (string, required when worker-pool specified), `--gcp-cloud-run-region` (string, required when worker-pool specified), `--gcp-cloud-run-worker-pool` (string), `--gcp-cloud-run-service-account` (string, required when worker-pool specified), `--gcp-cloud-run-min-instances` (int), `--gcp-cloud-run-max-instances` (int), `--gcp-cloud-run-initial-instances` (int), `--gcp-cloud-run-utilization-target` (float), `--remove` (bool). GCP scaler flags must be set together, and if omitted the version's existing settings remain unchanged.
temporal worker deployment update-version-metadata command
Update metadata of a Worker Deployment Version using `temporal worker deployment update-version-metadata [options]`. Required flags: `--deployment-name` (string), `--build-id` (string). Optional flags: `--metadata` (string[], accepts multiple KEY="VALUE" pairs where keys are identifiers and values are JSON), `--remove-entries` (string[], keys to delete, accepts multiple).
temporal worker describe command
Look up information of a specific worker using `temporal worker describe --namespace YourNamespace --worker-instance-key YourKey`. Required flag: `--worker-instance-key` (string) - Worker instance key to describe.