Getting Started

Scaffolding Your First Runow Project

Compatibility Note

Runow requires Node.js version 18+ or 20+. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.

npm

$ npm create runow@latest

yarn

$ yarn create runow

pnpm

$ pnpm create runow

bun

$ bun create runow

Then follow the prompts!

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a React + TypeScript project, run:

npm

# npm 7+, extra double-dash is needed:
$ npm create runow@latest your-app-name -- --template react-ts

yarn

$ yarn create runow your-app-name --template react-ts

pnpm

$ pnpm create runow your-app-name --template react-ts

bun

$ bun create runow your-app-name --template react-ts