Skip to content
Get packs

Guide · Open source

How to use Temporal: install the CLI, start a local server and run workflows

Updated · written with AI from the project's own documentation and checked against our catalogue data

Temporal is an open-source durable execution platform. The Temporal server runs units of application logic called Workflows and keeps them going through intermittent failures by retrying failed operations. This guide shows you how to start a local Temporal server, inspect it with the CLI and Web UI, and find the next steps for writing your own workflows.

Temporaltemporalio/temporal · ★ 24.1k · MIT

Quick start

  1. 1Install the CLI. Run brew install temporal. This requires Homebrew.
  2. 2Start the dev server. Run temporal server start-dev and keep it running.
  3. 3Check the server. In another terminal, run temporal workflow list or temporal operator namespace list.
  4. 4Open the Web UI. Visit http://localhost:8233 to see workflows executing.
  5. 5Clone a sample. Download the Go or Java samples repository and run a HelloWorld scenario against the local server.
  6. 6Write your own workflow. Implement Workflows, Activities and Workers in a supported language, using the Temporal developer guide.

What Temporal does and who it is for

Temporal lets developers build multi-step applications without writing all the retry and recovery logic themselves. The server executes Workflows in a resilient manner, automatically handling intermittent failures and retrying failed operations.

It suits backend developers building multi-step processes that must finish reliably, and teams building distributed microservice systems that need orchestration. It is written in Go and released under the MIT licence.

  • Good fit: multi-step processes that must finish reliably
  • Good fit: orchestrating distributed microservices
  • Poor fit: simple scripts or one-off jobs, since the setup adds infrastructure for little gain
  • Poor fit: non-developers, because workflows are written in code in supported languages such as Go or Java

Install the Temporal CLI with Homebrew

The README's quick start uses Homebrew. If you have Homebrew installed, run the install command below to get the Temporal CLI.

The Temporal CLI docs linked from the README cover other installation options.

brew install temporal

Start a local Temporal development server

Once the CLI is installed, start the local development server. The README says this starts a pre-built image along with all the dependencies, so you do not need to set those up separately.

Leave this command running while you work with the server in another terminal.

temporal server start-dev

Interact with the server using the CLI

With the server running, use the Temporal CLI to inspect it from another terminal. The README shows two example commands: one lists namespaces and the other lists workflows.

  • List namespaces with the operator namespace list command
  • List workflows with the workflow list command
temporal operator namespace list temporal workflow list

Open the Temporal Web UI

The Web UI is available while the local server runs. Open http://localhost:8233 in your browser to view sample workflows as they execute on Temporal.

Run samples and build your own workflows

The README points to sample repositories for Go and Java. Clone or download one and run it against your local server. The sets of samples differ between the two languages, and the Java samples include HelloWorld-style scenarios.

This repository holds only the server source code. To write Workflows, Activities and Workers, use one of the supported languages listed in the Temporal developer guide.

  • Go samples: github.com/temporalio/samples-go
  • Java samples: github.com/temporalio/samples-java
  • Language guide: docs.temporal.io/dev-guide

What people use it for

  • Running multi-step business processes that must complete despite intermittent failures
  • Orchestrating operations across distributed microservices
  • Trying out workflow execution locally with the CLI and Web UI before building a real system
  • Evaluating an open-source workflow engine written in Go

Frequently asked questions

Is Temporal free to use?

The source states that Temporal is released under the MIT licence, which is an open-source licence. Check the LICENSE file in the repository for the full terms.

How do I install Temporal?

The README installs the Temporal CLI with Homebrew using brew install temporal, then starts a local server with temporal server start-dev. The Temporal CLI docs list other installation options.

What do I need to run Temporal?

The README's quick start requires Homebrew for the install command shown. To write workflows, you need to use a supported language such as Go or Java.

Is Temporal the same as Cadence?

The README says Temporal is a fork of Uber's Cadence and is developed by Temporal Technologies, a startup by the creators of Cadence. Other comparable projects mentioned in our analysis include Apache Airflow, Camunda and Argo Workflows.

Why is the Web UI not loading at localhost:8233?

The Web UI is served while the local server is running. Make sure temporal server start-dev is still running in a terminal, then open http://localhost:8233. The source does not describe other troubleshooting steps.

Can I use Temporal for a simple script?

This is not recommended. Our analysis notes that the setup adds infrastructure for little gain on simple scripts or one-off jobs.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Temporal suits backend developers and teams who need multi-step processes to finish reliably, or who are orchestrating distributed microservices. It is a poor choice for simple scripts, one-off jobs, or teams that cannot run and operate a stateful server, for which a lighter tool is better.

Install options & downloads