Releases: temporalio/cli
v1.3.0
Highlights
- The built-in Temporal Server has been updated to 1.27.1, and UI Server has been updated to 2.36.0.
- There are significant changes to the experimental
temporal worker deployment
commands to expose new Worker Deployment features.
New Commands
temporal workflow metadata
shows user-set metadata for a specific Workflow Execution.temporal workflow signal-with-start
starts a new Workflow Execution and immediately sends it a Signal.
Updated Commands
- The experimental
temporal worker deployment
set of commands has been updated to expose new Worker Deployment features and improve the user experience. - The previously-experimental
temporal task-queue versioning
set of commands is now deprecated in favor oftemporal worker deployment
. temporal activity pause
andtemporal activity unpause
can now pause and resume all Activities of a specified type.temporal activity unpause
can now resume batches of activities, with jitter applied.temporal workflow list
now takes a--page-size
option, to be used in exceptional situations when fetching Workflow Executions from the server takes too long.- The new
--static-summary
and--static-details
flags can be passed to any command that starts a Workflow Execution, to provide user-defined metadata retrievable via the UI or withtemporal workflow metadata
.
What's Changed
- Fix register search attributes when starting server by @rodrigozhou in #653
- Show blocked state for pending nexus operation, cancelation, and callback by @rodrigozhou in #706
- Replace runner macos-14 with macos-13 in CI tests by @rodrigozhou in #709
- Fix whitespace in
temporal batch --help
output by @josh-berry in #722 - ci: Directly check for needed secrets before testing against cloud by @josh-berry in #725
- Bump github.com/golang-jwt/jwt/v4 from 4.5.0 to 4.5.1 by @dependabot in #703
- CLI comamnd for UpdateActivityOptions API by @ychebotarev in #729
- CLI for pause/unpause activity API by @ychebotarev in #730
- Expose the underlying slog logger to the dev server by @bergundy in #731
- Remove incorrect statement in
workfow list
command description by @mjameswh in #716 - Bump golang.org/x/crypto from 0.26.0 to 0.31.0 by @dependabot in #728
- disable tq info caching in task queue test by @carlydf in #726
- Add CLI command for Reset activity API by @ychebotarev in #732
- Bump server to 1.26.2, enable HTTP by default by @bergundy in #734
- Merge branch 'next-server' into main by @josh-berry in #737
- Bump golang.org/x/net from 0.31.0 to 0.33.0 by @dependabot in #738
- UI Server -> 2.34.0 by @josh-berry in #739
- Versioning 3 by @antlai-temporal in #740
- Add
workflow metadata
command by @Sushisource in #743 - Updates to the activity API by @ychebotarev in #746
- Add batch activity unpause. by @ychebotarev in #747
- Rename Nexus OperationID to OperationToken by @bergundy in #750
- Update dependencies by @rodrigozhou in #752
- Add codec-header config (closes #753) by @EddieWhi in #755
- Remove experimental labels from Nexus operator commands by @bergundy in #757
- Rebase from main, update deps, test fixes by @antlai-temporal in #756
- Specify pagesize for workflow list command by @yiminc in #748
- Bump Temporal Server to v1.27.0-rc.0 by @rodrigozhou in #760
- Add
temporal workflow signal-with-start
command by @THardy98 in #758 - Deployment API (versioning 3.1) by @antlai-temporal in #765
- Update server to v1.27.1 by @antlai-temporal in #767
- Rebase to main by @antlai-temporal in #768
- User Metadata set on start / desc by @Sushisource in #742
- Fix batch deployment test nil pointer exception by @antlai-temporal in #769
- Add fields from extended info to DescribeWorkflow output by @ychebotarev in #771
New Contributors
- @ychebotarev made their first contribution in #729
- @EddieWhi made their first contribution in #755
- @THardy98 made their first contribution in #758
Full Changelog: v1.1.2...v1.3.0
v1.3.0-rc.0
DO NOT USE IN PRODUCTION. This is a development release.
What's Changed
- Updates to the activity API by @ychebotarev in #746
- Add batch activity unpause. by @ychebotarev in #747
- Rename Nexus OperationID to OperationToken by @bergundy in #750
- Remove experimental labels from Nexus operator commands by @bergundy in #757
- Rebase from main, update deps, test fixes by @antlai-temporal in #756
- Bump Temporal Server to v1.27.0-rc.0 by @rodrigozhou in #760
Full Changelog: v1.2.0...v1.3.0-rc.0
v1.3.0-versioning.0
DO NOT USE IN PRODUCTION. This is a development release to make some worker versioning functionality available to try out.
What's Changed
- Fix register search attributes when starting server by @rodrigozhou in #653
- Show blocked state for pending nexus operation, cancelation, and callback by @rodrigozhou in #706
- Replace runner macos-14 with macos-13 in CI tests by @rodrigozhou in #709
- Fix whitespace in
temporal batch --help
output by @josh-berry in #722 - ci: Directly check for needed secrets before testing against cloud by @josh-berry in #725
- Bump github.com/golang-jwt/jwt/v4 from 4.5.0 to 4.5.1 by @dependabot in #703
- CLI comamnd for UpdateActivityOptions API by @ychebotarev in #729
- CLI for pause/unpause activity API by @ychebotarev in #730
- Expose the underlying slog logger to the dev server by @bergundy in #731
- Remove incorrect statement in
workfow list
command description by @mjameswh in #716 - Bump golang.org/x/crypto from 0.26.0 to 0.31.0 by @dependabot in #728
- disable tq info caching in task queue test by @carlydf in #726
- Add CLI command for Reset activity API by @ychebotarev in #732
- Bump server to 1.26.2, enable HTTP by default by @bergundy in #734
- Merge branch 'next-server' into main by @josh-berry in #737
- Updates to the activity API by @ychebotarev in #746
- Add batch activity unpause. by @ychebotarev in #747
- Rename Nexus OperationID to OperationToken by @bergundy in #750
- Remove experimental labels from Nexus operator commands by @bergundy in #757
- Rebase from main, update deps, test fixes by @antlai-temporal in #756
New Contributors
- @ychebotarev made their first contribution in #729
Full Changelog: v1.1.2...v1.3.0-versioning.0
v1.2.0
Highlights
This release includes the latest versions Temporal Server (v1.26.2) and UI Server (v2.34.0), and provides provides updated support for the revamped experimental Worker Versioning feature, and includes additional commands for managing Activities.
New Commands
temporal worker deployment ...
commands operate on Worker Deployments, a new concept introduced with the revamped Worker Versioning feature. These commands are experimental (pre-release) and are subject to change and/or removal.temporal workflow update-options
adjusts options on specific Workflows related to Worker Versioning. This command is experimental (pre-release) and is subject to change and/or removal.temporal activity update-options
adjusts options such as timeout and retry values on running Activities.temporal activity pause
stops an Activity from being retried, leaving it in a blocked state.temporal activity unpause
allows a previously-paused Activity to be retried once again.temporal activity reset
resets the timeouts and number of retry attempts on a running Activity.
What's Changed
- Fix register search attributes when starting server by @rodrigozhou in #653
- Show blocked state for pending nexus operation, cancelation, and callback by @rodrigozhou in #706
- Replace runner macos-14 with macos-13 in CI tests by @rodrigozhou in #709
- Fix whitespace in
temporal batch --help
output by @josh-berry in #722 - ci: Directly check for needed secrets before testing against cloud by @josh-berry in #725
- Bump github.com/golang-jwt/jwt/v4 from 4.5.0 to 4.5.1 by @dependabot in #703
- CLI comamnd for UpdateActivityOptions API by @ychebotarev in #729
- CLI for pause/unpause activity API by @ychebotarev in #730
- Expose the underlying slog logger to the dev server by @bergundy in #731
- Remove incorrect statement in
workfow list
command description by @mjameswh in #716 - Bump golang.org/x/crypto from 0.26.0 to 0.31.0 by @dependabot in #728
- disable tq info caching in task queue test by @carlydf in #726
- Add CLI command for Reset activity API by @ychebotarev in #732
- Bump server to 1.26.2, enable HTTP by default by @bergundy in #734
- Merge branch 'next-server' into main by @josh-berry in #737
- Bump golang.org/x/net from 0.31.0 to 0.33.0 by @dependabot in #738
- UI Server -> 2.34.0 by @josh-berry in #739
- Versioning 3 by @antlai-temporal in #740
New Contributors
- @ychebotarev made their first contribution in #729
Full Changelog: v1.1.2...v1.2.0
v1.2.0-versioning.0
DO NOT USE IN PRODUCTION. This is a development release to make some worker versioning functionality available to try out.
What's Changed
- Replace runner macos-14 with macos-13 in CI tests by @rodrigozhou in #709
- Fix whitespace in
temporal batch --help
output by @josh-berry in #722 - ci: Directly check for needed secrets before testing against cloud by @josh-berry in #725
- Bump github.com/golang-jwt/jwt/v4 from 4.5.0 to 4.5.1 by @dependabot in #703
Full Changelog: v1.1.2...v1.2.0-versioning.0
v1.1.2
Highlights
- Updates Temporal Server to 1.25.2 and UI Server to 2.32.0.
temporal workflow reset
now respects the--reapply-*
options when operating in batch mode.
What's Changed
- Fix mismatched go versions (and AS casing) by @LeeBrotherston in #702
- Improved docs gen by @prasek in #691
- Upgrade the macos runner in ci workflow by @rodrigozhou in #707
- Add reset reapply to batch reset command by @jamipouchi in #700
- change log-format to string-enum by @yuandrew in #711
- Fix flaky reset test by @dandavison in #713
- Version bumps: Server -> 1.25.2; UI Server -> 2.32.0 by @josh-berry in #712
New Contributors
- @LeeBrotherston made their first contribution in #702
- @jamipouchi made their first contribution in #700
Full Changelog: v1.1.1...v1.1.2
v1.1.1
Highlights
- Updates Temporal Server to v1.25.1, and UI Server to v2.31.2
- Improves
--help
documentation in several areas, especially fortemporal operator nexus
commands. - Adds a global
--command-timeout
option to force the CLI to exit with an error if the command cannot be completed in the requested time. - Adds a
--rps
option to batch operations to limit the number of requests per second. - Adds an
--id-conflict-policy
option everywhere workflows are started that specifies what to do if the desired Workflow ID already exists. - Fixes an issue where
--reapply-type All
was not re-applying Updates.
What's Changed
- Cap UI port at max value by @Sushisource in #671
- Use YAML for CLI command generation by @yuandrew in #666
- Batch rate limit by @stephanos in #675
- Create new
string-enum[]
type by @yuandrew in #677 - Add global
context-rpc-timeout
option by @yuandrew in #676 - Make
--reapply-type All
reapply updates in addition to signals by @dandavison in #680 - EDU-3157: Add instructions on how to remove Search Attributes by @fairlydurable in #683
- fix(sqlite): support all sqlite pragma statement by @vbehar in #682
- Improving
Describe-TQ
Command Description by @Shivs11 in #684 - Auto generate CLI docs for documentation repo by @yuandrew in #685
- Add id-conflict-policy by @yuandrew in #688
- Warn users not to use dev-server in production by @josh-berry in #689
- Update nexus commands.yml for docs gen by @prasek in #693
- update --command-timeout description by @prasek in #694
- Version bumps: Server -> 1.25.1; UI Server -> 2.31.2 by @josh-berry in #696
New Contributors
Full Changelog: v1.1.0...v1.1.1
v1.1.0
💥 Breaking Changes
temporal workflow update
has been renamed totemporal workflow update execute
, to allow for the creation of newworkflow update
sub-commands. All flags and behavior remain the same.
Highlights
- The
temporal nexus
suite of commands has been added to support Nexus, a new feature designed to connect durable executions across team, namespace, region, and cloud boundaries. It promotes a more modular architecture for sharing a subset of your team’s capabilities via well-defined service API contracts for other teams to use, that abstract underlying Temporal primitives, like Workflows, or execute arbitrary code. Learn more at: https://temporal.io/nexus - The new
temporal workflow update start
command starts an Update asynchronously. Callers can wait for such an Update to complete by running anupdate execute
orupdate result
command against the same--workflow-id
and--update-id
. - The new
temporal workflow update result
command waits for an Update to complete and fetches the result. - The new
temporal workflow update describe
command reports the status of a running or recently-completed Update. Unlikeupdate result
andupdate execute
,update describe
does NOT wait for the update to complete, but returns status immediately. - The
temporal task-queue describe
command now returns improved backlog stats including backlog count, age, and growth rate. - Temporal Server has been updated to v1.25.0, and UI Server has been updated to v2.30.3.
What's Changed
- Nexus by @bergundy in #577
- Use static membership for devserver by @stephanos in #582
- Fix dev server search attribute registration helptext by @Sushisource in #636
- Include additional build-time information in the version string by @dandavison in #637
- Fix typo in
schedule create
example by @josh-berry in #640 - add --public-path option to the command by @ggrebert in #644
- Making tq stats visible from cli by @Shivs11 in #638
- Add
workflow update start
andworkflow update execute
subcommands by @dandavison in #642 - Upgrade server with endpoint regexp validation to allow "-" and deny "_" by @bergundy in #641
- Dump junit.xml by @dandavison in #650
- Upgrade server to 1.25.0-rc.2 by @bergundy in #655
- List schedules query param support by @justinp-tt in #654
- Reduce test suite time by @yuandrew in #656
- Remove in-development warning from README by @josh-berry in #657
- Update major Temporal dependencies by @josh-berry in #659
- Update major Temporal dependencies by @josh-berry in #661
- Update help text to conform to style by @josh-berry in #662
- Merge nexus branch into main by @josh-berry in #663
- Add workflow
update result
,update describe
andresult
commands by @Sushisource in #658 - changes to tq-describe-command descriptions by @Shivs11 in #668
New Contributors
- @ggrebert made their first contribution in #644
- @Shivs11 made their first contribution in #638
- @justinp-tt made their first contribution in #654
- @yuandrew made their first contribution in #656
Full Changelog: v1.0.0...v1.1.0
v1.0.0
Temporal CLI Reaches 1.0
Temporal CLI is now considered featureful enough to be v1.0! 🎉 It continues to be production-quality.
Future releases will maintain the same commands, flags, behaviors, and JSON output to the extent possible (except for experimental features, which will be clearly marked as such in --help
output). Text output is still subject to change.
Release Highlights (since v0.13.0)
- The experimental Worker Versioning feature was added in v0.13.1, making it easier to manage multiple worker versions running on the same task queue. (Commands associated with this feature are subject to change.)
- Search attributes can now be created during dev-server startup using the new
--search-attribute
flag. - The
--help
output has been rewritten top-to-bottom to be more comprehensive and informative.
Upgrading from Older Versions
If you are switching from tctl
or upgrading from a CLI version older than v0.12.0, please note that many commands have changed. See the release notes for v0.12.0 for more details.
What's Changed
- Supported flattened event detail view on workflow show/execute by @cretz in #615
- Tweak server start-up text by @dandavison in #624
- Fix nil deref if the env file can't be parsed by @josh-berry in #625
- Adjust dev-server tunables to avoid persistence rate-limiting by @josh-berry in #626
- EDU-2415: Improve CLI Help content by @fairlydurable in #561
- Dependency Updates: Server -> 1.24.2, Cobra -> 1.8.1, and more by @josh-berry in #630
Full Changelog: v0.13.2...v1.0.0
v0.14.0-nexus.0
What's Changed
- Supported flattened event detail view on workflow show/execute by @cretz in #615
- Tweak server start-up text by @dandavison in #624
- Fix nil deref if the env file can't be parsed by @josh-berry in #625
- Nexus by @bergundy in #577
Full Changelog: v0.13.2...v0.14.0-nexus.0