Skip to main content

Setup

Configure your local development environment to get started developing with Temporal.

Install Node.js​

The TypeScript SDK requires Node.js 16 or later. Install Node.js via your package manager by following the official Node.js instructions.

The TypeScript SDK requires Node.js 16 or later.

Install Node.js via your package manager by following the official Node.js instructions.

Install the Temporal TypeScript SDK​

You can create a new project with the Temporal SDK:

You can also add the Temporal TypeScript SDK to an existing project with the following command.

Next, you'll configure a local Temporal Service for development.

npx @temporalio/create@latest ./my-app
npm install @temporalio/client @temporalio/worker @temporalio/workflow

Install Temporal CLI​

The fastest way to get a development version of the Temporal Service running on your local machine is to use Temporal CLI.

Install Temporal CLI on your local machine using the following instructions for your platform.

brew install temporal

Start the development server​

Once you've installed Temporal CLI and added it to your PATH, open a new Terminal window and run the following command.

This command starts a local Temporal Service. It starts the Web UI, creates the default Namespaces, and uses an in-memory database.

The Temporal Service will be available on localhost:7233. The Temporal Web UI will be available at http://localhost:8233.

Leave the local Temporal Service running as you work through tutorials and other projects. You can stop the Temporal Service at any time by pressing CTRL+C.

The temporal server start-dev command uses an in-memory database, so stopping the server will erase all your Workflows and all your Task Queues. If you want to retain those between runs, start the server and specify a database filename using the --db-filename option, like this:

temporal server start-dev

Change the Web UI port

The Temporal Web UI may be on a different port in some examples or tutorials. To change the port for the Web UI, use the --ui-port option when starting the server:

temporal server start-dev --ui-port 8080

The Temporal Web UI will now be available at http://localhost:8080.

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

Next: Run your first Temporal Application

Learn how to create a basic Workflow and run it with the Temporal TypeScript SDK

→