Skip to main content

Interface: DevServerConfig

Configuration for the Temporal CLI Dev Server.

Properties​

dbFilename?​

optional dbFilename?: string

Sqlite DB filename if persisting or non-persistent if none (default).

executable?​

optional executable?: EphemeralServerExecutable

extraArgs?​

optional extraArgs?: string[]

Extra args to pass to the executable command.

Note that the Dev Server implementation may be changed to another one in the future. Therefore, there is no guarantee that Dev Server options, and particularly those provided through the extraArgs array, will continue to be supported in the future.

ip?​

optional ip?: string

IP to bind to.

Default​

localhost

log?​

optional log?: object

Log format and level

format​

format: string

level​

level: string

Default​

{ format: "pretty", level" "warn" }

namespace?​

optional namespace?: string

Namespace to use - created at startup.

Default​

"default"

port?​

optional port?: number

Port to listen on; defaults to find a random free port.

searchAttributes?​

optional searchAttributes?: SearchAttributeKey<SearchAttributeType>[]

Search attributes to be registered with the dev server.

startupTimeout?​

optional startupTimeout?: Duration

Maximum time to wait for server readiness after spawning the process, excluding executable download time.

Default​

'5s'

type​

type: "dev-server"

ui?​

optional ui?: boolean

Whether to enable the UI.

Default​

true if uiPort is set; defaults to false otherwise.

uiPort?​

optional uiPort?: number

Port to listen on for the UI; if ui is true, defaults to port + 1000.