Skip to main content

Temporal CLI server command reference

Server commands allow you to start and manage the Temporal Server 🔗

What is the Temporal Server?
The Temporal Server is a grouping of four horizontally scalable services.
term explanation
from the command line.

Currently, cli server functionality extends to starting the Server.

start-dev

The temporal server start-dev command starts the Temporal Server on localhost:7233.

The results of any command run on the Server can be viewed at http://localhost:7233.

  • --config 🔗

    temporal config
    Path to config directory.
    cli reference temporal cli options-feature command-line-interface-cli configuration

  • --db-filename 🔗

    temporal db-filename
    File in which to persist Temporal state.
    cli reference temporal cli options-feature command-line-interface-cli external temporal and state events

  • --dynamic-config-value 🔗

    temporal dynamic-config-value
    Dynamic config value, as KEY=JSON_VALUE.
    cli reference temporal cli options-feature command-line-interface-cli configuration

  • --headless 🔗

    temporal headless
    Disable the Web UI.
    cli reference temporal cli options-feature command-line-interface-cli web ui temporal ui

  • --ip 🔗

    temporal ip
    IPv4 address to bind the frontend service to.
    cli reference temporal cli options-feature command-line-interface-cli, frontend service server options and configurations

  • --log-format 🔗

    temporal log-format
    Set the log formatting.
    cli reference temporal cli options-feature command-line-interface-cli log-feature logging

  • --log-level 🔗

    temporal log-level
    Set the log level.
    cli reference temporal cli options-feature command-line-interface-cli logging log-feature logging and metrics

  • --metrics-port 🔗

    temporal metrics-port
    Port for /metrics
    cli reference temporal cli options-feature command-line-interface-cli logging and metrics metrics

  • --namespace 🔗

    temporal namespace
    Identifies a Namespace in the Temporal Workflow.
    cli reference temporal cli options-feature command-line-interface-cli namespace namespace management

  • --port 🔗

    temporal port
    Port for the frontend gRPC service.
    cli reference temporal cli options-feature command-line-interface-cli frontend service grpc

  • --sqlite-pragma 🔗

    temporal sqlite-pragma
    Specify sqlite pragma statements in pragma=value format.
    cli reference temporal cli options-feature command-line-interface-cli sqlite pragma

  • --ui-asset-path 🔗

    temporal ui-asset-path
    UI Custom Assets path.
    cli reference temporal cli options-feature command-line-interface-cli temporal ui

  • --ui-codec-endpoint 🔗

    temporal ui-codec-endpoint
    UI Remote data converter HTTP endpoint.
    cli reference temporal cli options-feature command-line-interface-cli data converters http endpoint temporal ui

  • --ui-ip 🔗

    temporal ui-ip
    IPv4 address to bind the Web UI to.
    cli reference temporal cli options-feature command-line-interface-cli web ui ip address

  • --ui-port 🔗

    temporal ui-port
    Port for the Web UI.
    cli reference temporal cli options-feature command-line-interface-cli web ui port