temporalio-typescript

Flox development environment for the Temporal TypeScript SDK.

Quick start

# Clone and activate locally
git clone https://github.com/flox/temporalio-typescript.git
cd temporalio-typescript
flox activate

# Start the Temporal dev server (gRPC :7233, Web UI :8233)
flox services start

# Or use remotely without cloning (e.g., inside an existing project)
# flox activate -r flox/temporalio-typescript

Run a sample workflow

# In a new terminal inside the activated environment
npx @temporalio/create@latest ./my-app
cd my-app

# Start the worker
npx ts-node src/worker.ts &

# Execute the workflow
temporal workflow execute \
  --task-queue hello-world \
  --type example \
  --input '"Temporal"'

# Open http://localhost:8233 to see the workflow in the Web UI

What's included

Category	Packages
Language	Node.js 22
Temporal	temporal-cli 1.6.2 (CLI + embedded dev server + Web UI)
Rust	rustup (for building sdk-core native bridge from source)
Protobuf	protobuf (protoc)
Utilities	git, jq, curl, grpcurl, sqlite, openssl

Services

flox services start     # Start Temporal dev server
flox services status    # Check status
flox services stop      # Stop dev server

The temporal-dev service runs temporal server start-dev with SQLite persistence at $FLOX_ENV_CACHE/temporal-dev.db. Data survives restarts.

Environment variables

Variable	Value	Purpose
TEMPORAL_ADDRESS	localhost:7233	Default server address for CLI and SDK
TEMPORAL_UI_PORT	8233	Web UI port
NPM_CONFIG_CACHE	$FLOX_ENV_CACHE/npm-cache	npm cache inside Flox cache

Platforms

aarch64-darwin, x86_64-darwin, x86_64-linux, aarch64-linux