@temporalio/create | GitHub
@temporalio/create is an optional tool to set up a new Temporal project starting from our samples repo.
See the Getting started guide for basic usage and environment set up before running this tool.
npx @temporalio/create@latest ./example
--sample— Which sample to bootstrap the app with. You can use the name of a sample from github.com/temporalio/samples-typescript or use a GitHub URL. The URL can have a branch and/or subdirectory: for example,
--list-samples— List available projects from our samples repo.
--use-yarn— Use Yarn instead of npm.
--[no-]git-init- Initialize an empty git repository.
--sdk-version <version>- Specify which version of the
@temporalio/*npm packages to use.
Typically, the generated project consists of 4 main components:
- Worker that executes Workflows and Activities
- A script to execute a Workflow (using a Temporal Client)
Working with the created project
Most sample projects come with these scripts:
npm start— Run the Worker with
ts-node(does not require a compilation step)
npm run start.watch— Watch files with
nodemonand re-run Worker on change
npm run build— Compile TypeScript
npm run build.watch— Watch files and compile on change
npm run workflow— Execute a Workflow
If you aren't familiar with the tradeoffs between these choices, we recommend primarily running
npm run start.watch to have a live-reloading Worker good enough for most situations, and then
npm run workflow to start individual Workflow executions.