cli

Temporal CLI

Temporal command-line interface and development server.

DOCUMENTATION

Quick Install

Reference the documentation for detailed install information.

Install via Homebrew

brew install temporal

Install via download

1. Download the version for your OS and architecture:
   • Linux amd64
   • Linux arm64
   • macOS amd64
   • macOS arm64 (Apple silicon)
   • Windows amd64
2. Extract the downloaded archive.
3. Add the temporal binary to your PATH (temporal.exe for Windows).

Run via Docker

Temporal CLI on DockerHub

docker run --rm temporalio/temporal --help

Note that for dev server to be accessible from host system, it needs to listen on external IP and the ports need to be forwarded:

docker run --rm -p 7233:7233 -p 8233:8233 temporalio/temporal:latest server start-dev --ip 0.0.0.0
# UI is now accessible from host at http://localhost:8233/

Build

1. Install Go
2. Clone repository
3. Switch to cloned directory, and run go build ./cmd/temporal

The executable will be at temporal (temporal.exe for Windows).

Usage

Reference the documentation for detailed usage information.

Contributing

See CONTRIBUTING.md.