Temporal

Server

Server management

Workflow

Workflow operations

29commands

Activity

Activity operations

Schedule

Schedule management

13commands

Namespace

Namespace management

8commands

Task Queue

Task queue operations

Search Attributes

Search attribute management

Batch

Batch operations

Environment

Environment configuration

7commands

Install Temporal CLI (macOS)

$ brew install temporal

Install Temporal CLI using Homebrew on macOS

Install Temporal CLI (Linux)

$ curl -sSf https://temporal.download/cli.sh | sh

Install Temporal CLI on Linux using the official installer

Start local dev server

$ temporal server start-dev

Start Temporal development server locally (runs at localhost:7233, UI at localhost:8233)

Verify installation

$ temporal workflow list

List workflows to verify Temporal CLI and server connection

Start dev server

$ temporal server start-dev

Start local Temporal server with Web UI at localhost:8233.

Start with persistent DB

$ temporal server start-dev --db-filename temporal.db

Start server with SQLite persistence for state across restarts.

Start with custom namespaces

$ temporal server start-dev --namespace dev --namespace staging

Pre-register multiple namespaces at startup.

Start with custom ports

$ temporal server start-dev --port 7233 --ui-port 8233

Configure gRPC and Web UI ports.

Start headless (no UI)

$ temporal server start-dev --headless

Start server without Web UI.

Register search attributes

$ temporal server start-dev --search-attribute 'CustomField=Text'

Pre-register custom search attributes (Text, Keyword, Int, Double, Bool, Datetime, KeywordList).

Complete activity

$ temporal activity complete --workflow-id my-wf --activity-id my-activity --result '{"status":"done"}'

Manually mark activity as successfully completed.

Complete with run ID

$ temporal activity complete --workflow-id my-wf --run-id abc123 --activity-id my-activity --result '{}'

Complete activity for specific workflow run.

Fail activity

$ temporal activity fail --workflow-id my-wf --activity-id my-activity

Manually mark activity as failed.

Fail with reason and detail

$ temporal activity fail --workflow-id my-wf --activity-id my-activity --reason 'Timeout' --detail '{"error":"connection lost"}'

Fail activity with detailed error information.

Create schedule with interval

$ temporal schedule create --schedule-id my-schedule --interval 1h --workflow-id scheduled-wf --type MyWorkflow --task-queue my-queue

Create schedule that runs workflow every hour.

Create with cron

$ temporal schedule create --schedule-id daily-job --cron '0 3 * * *' --workflow-id daily-wf --type DailyWorkflow --task-queue my-queue

Create schedule using cron expression (daily at 3 AM).

Create with calendar

$ temporal schedule create --schedule-id weekly --calendar '{"dayOfWeek":"Fri","hour":"17","minute":"0"}' --workflow-id weekly-wf --type WeeklyWorkflow --task-queue my-queue

Create schedule with calendar specification (every Friday at 5 PM).

Create with overlap policy

$ temporal schedule create --schedule-id my-schedule --interval 30m --overlap-policy BufferAll --workflow-id wf --type MyWorkflow --task-queue my-queue

Set policy for overlapping executions (Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll).

List schedules

$ temporal schedule list

List all schedules in namespace.

List with details

$ temporal schedule list --long

List schedules with extended information.

Describe schedule

$ temporal schedule describe --schedule-id my-schedule

Show schedule configuration and execution history.

Trigger schedule immediately

$ temporal schedule trigger --schedule-id my-schedule

Execute scheduled workflow immediately (subject to overlap policy).

Update schedule

$ temporal schedule update --schedule-id my-schedule --interval 2h

Modify existing schedule configuration.

Pause schedule

$ temporal schedule toggle --schedule-id my-schedule --pause --reason 'Maintenance'

Pause schedule execution with reason.

Unpause schedule

$ temporal schedule toggle --schedule-id my-schedule --unpause

Resume paused schedule.

Backfill schedule

$ temporal schedule backfill --schedule-id my-schedule --start-time '2024-01-01T00:00:00Z' --end-time '2024-01-31T23:59:59Z'

Execute missed runs for a time period.

Delete schedule

$ temporal schedule delete --schedule-id my-schedule

Remove schedule (doesn't affect running executions).

Create namespace

$ temporal operator namespace create --namespace production

Create a new namespace.

Create with retention

$ temporal operator namespace create --namespace prod --retention 168h

Create namespace with custom retention (7 days).

Create global namespace

$ temporal operator namespace create --namespace global-ns --global

Create multi-region namespace for cluster replication.

List namespaces

$ temporal operator namespace list

Display all namespaces on the server.

Describe namespace

$ temporal operator namespace describe --namespace production

Show detailed namespace configuration.

Update namespace retention

$ temporal operator namespace update --namespace prod --retention 336h

Update retention period to 14 days.

Enable archival

$ temporal operator namespace update --namespace prod --history-archival-state enabled

Enable history archival for long-term storage.

Delete namespace

$ temporal operator namespace delete --namespace old-ns --yes

Permanently delete namespace and all workflow history.

Describe task queue

$ temporal task-queue describe --task-queue my-queue

Show active workers, backlog, and statistics.

Describe with reachability

$ temporal task-queue describe --task-queue my-queue --select-build-id v1.2.3 --report-reachability

Check Build ID reachability for versioning.

List task queue partitions

$ temporal task-queue list-partition --task-queue my-queue

Display partition assignments and matching nodes.

List search attributes

$ temporal operator search-attribute list

Display all available search attributes.

Create Text attribute

$ temporal operator search-attribute create --name Description --type Text

Create full-text searchable attribute.

Create Keyword attribute

$ temporal operator search-attribute create --name Environment --type Keyword

Create exact-match string attribute.

Create Int attribute

$ temporal operator search-attribute create --name Priority --type Int

Create integer attribute for numeric filtering.

Create KeywordList attribute

$ temporal operator search-attribute create --name Tags --type KeywordList

Create multi-value keyword attribute.

Remove search attribute

$ temporal operator search-attribute remove --name OldAttribute --yes

Delete custom search attribute.

List batch jobs

$ temporal batch list

Show all batch operations in namespace.

Describe batch job

$ temporal batch describe --job-id my-batch-job

Show batch operation progress and status.

Terminate batch job

$ temporal batch terminate --job-id my-batch-job --reason 'Cancelled by user'

Stop running batch operation.

List environments

$ temporal env list

Display all configured CLI environments.

Get environment config

$ temporal env get --env production

Show all properties for an environment.

Get specific property

$ temporal env get --env prod --key address

Display single environment property value.

Set environment property

$ temporal env set --env prod --key address --value temporal.example.com:7233

Store server address in environment.

Set namespace

$ temporal env set --env prod --key namespace --value production

Store default namespace for environment.

Delete environment property

$ temporal env delete --env prod --key tls-key-path

Remove specific key from environment.

Delete entire environment

$ temporal env delete --env old-env

Remove complete environment configuration.

Discussion

Loading comments...

Temporal

Durable workflow orchestration commands. Manage workflows, activities, namespaces, and task queues from the CLI.

83 commands

Browse by Topic

Getting Started

Quick setup and installation

Server

Server management

Workflow

Workflow operations

29commands

Activity

Activity operations

Schedule

Schedule management

13commands

Namespace

Namespace management

8commands

Task Queue

Task queue operations

Search Attributes

Search attribute management

Batch

Batch operations