You can run "Hello Temporal" locally in under 5 minutes, assuming you have all prerequisites set up.
This project requires nodejs LTS version 14 (or later).
Furthermore, you will need to install node-gyp.
If you run into errors during installation it is likely your environment is not properly set up.
The Worker package embeds the Temporal Core SDK which requires the Rust toolchain to compile.
We've provided prebuilt binaries for the Worker for:
- Mac with an Intel chip:
- Mac with an Apple chip:
- Linux with x86_64 architecture:
- Windows with x86_64 architecture:
x86_64-pc-windows-gnu(Windows is not yet supported but it is a priority for us).
If you need to compile the Worker yourself, set up the Rust toolchain by following the instructions here.
Brew installation of NodeJS>=15 does not work with the SDK, install Node with
Make sure you also have Temporal Server running. If you haven't set it up yet, we recommend following the Temporal Server Quick Install via docker-compose:
Use the package initializer to create a new project.
This will set up with the basic Hello World sample.
If you want a sample for connecting to a Temporal Server instance secured with mTLS, you can use
npx @temporalio/create@latest ./example --sample hello-world-mtls.
init triggers native module compilation which might take a while, npm 7 hides the compilation output so it may appear that the installation is stuck, to see the compilation progress export
Use one of the provided helper package scripts to compile Typescript.
Run the Worker:
Then start your Workflow:
This "Hello Temporal" message comes from the combination of:
- "Hello" from the Activity
- and "Temporal" from
- as compiled from your
/libfolder by TypeScript.
You can verify this via the Input and Result fields in Temporal Web (available at
localhost:8088 on the default
For a full code walkthrough of the Hello World example that you have spun up here, see our Hello World documentation.