Skip to main content

tctl v1.17 data-converter command reference

Temporal CLI is now available!

The new Temporal CLI is available for use.

tctl v1.17 can still be used with Temporal Server version 1.20 and is expected to be compatible with Temporal Server version 1.21.

tctl is expected to be fully deprecated by Temporal Server version 1.22

The tctl dataconverter command enables custom Data Converter 🔗

Link preview
What is a Data Converter?
A Data Converter is a Temporal SDK component that serializes and encodes data entering and exiting a Temporal Cluster.
term explanation
operations.

  • tctl dataconverter web 🔗
    Link preview
    tctl dataconverter web
    How to specify the WebSocket URL of a custom Data Converter using tctl.
    tctl cli reference

web​

The tctl dataconverter web command specifies the WebSocket URL of a custom Data Converter 🔗

Link preview
What is a Data Converter?
A Data Converter is a Temporal SDK component that serializes and encodes data entering and exiting a Temporal Cluster.
term explanation
to use with Temporal Web.

tctl dataconverter web --web_ui_url <url>

The following modifiers control the behavior of the command.

--port​

Specify a port for the WebSocket URL of a custom Data Converter 🔗

Link preview
What is a Data Converter?
A Data Converter is a Temporal SDK component that serializes and encodes data entering and exiting a Temporal Cluster.
term explanation
. The default value is 0.

Example

tctl dataconverter web --web_ui_url <url> --port <value>

--web_ui_url​

Required modifier

Specify the WebSocket URL of a custom Data Converter 🔗

Link preview
What is a Data Converter?
A Data Converter is a Temporal SDK component that serializes and encodes data entering and exiting a Temporal Cluster.
term explanation
.

Example

tctl dataconverter web --web_ui_url <url>