Install Rune

Run the create rune-app command and answer a few prompts to quickly scaffold a new Rune project.

Prerequisites

• Node.js - v22.12.0 or higher
• Terminal - Rune requires command-line access to initialize a project

Installation

1. Create a new project

   Run the following command in your terminal to create a new Rune project.

   pnpm

   pnpm create rune-app

   npm

   npm create rune-app@latest

   yarn

   yarn create rune-app

   bun

   bun create rune-app

   You will be prompted for a project name, whether to install dependencies, and whether to initialize a git repository.

   You can also pass the project name directly as an argument.

   pnpm

   pnpm create rune-app my-cli

   npm

   npm create rune-app@latest my-cli

   yarn

   yarn create rune-app my-cli

   bun

   bun create rune-app my-cli

   To scaffold into the current directory, pass . instead of a project name. The directory must not contain files that conflict with the template (e.g. .gitignore, package.json, tsconfig.json, or src/).

   pnpm

   pnpm create rune-app .

   npm

   npm create rune-app@latest .

   yarn

   yarn create rune-app .

   bun

   bun create rune-app .

2. Run a command

   Navigate to your project directory and run the starter hello command to verify everything works.

   pnpm

   cd my-cli
   pnpm start hello

   npm

   cd my-cli
   npm run start -- hello

   yarn

   cd my-cli
   yarn start hello

   bun

   cd my-cli
   bun start hello

   npm

   When using npm run, pass the command arguments after an extra --.

   npm run start -- hello # Run the hello command
   npm run start -- --help # Show help for the my-cli CLI
   npm run start -- hello --help # Show help for the hello command

   If you see the following output, you’re all set.

   hello from my-cli

Non-interactive mode

Pass the --yes (-y) flag to skip all interactive prompts and use default values. This also happens automatically in CI pipelines, agent-driven workflows, and other environments without a TTY.

pnpm

pnpm create rune-app my-cli --yes

# Or scaffold into the current directory
pnpm create rune-app . --yes

npm

npm create rune-app@latest my-cli -- --yes

# Or scaffold into the current directory
npm create rune-app@latest . -- --yes

yarn

yarn create rune-app my-cli --yes

# Or scaffold into the current directory
yarn create rune-app . --yes

bun

bun create rune-app my-cli --yes

# Or scaffold into the current directory
bun create rune-app . --yes

npm

npm create (and npm init) consumes flags itself, so you must separate flags from the package arguments with --. Other package managers forward flags directly and do not need the -- separator.

You can fine-tune the behavior with additional options:

Option	Default	Description
--yes / -y	false	Skip all prompts
--install / --no-install	true	Install dependencies
--git / --no-git	true	Initialize a git repository

pnpm

# Skip dependency installation
pnpm create rune-app my-cli --yes --no-install

# Skip git initialization
pnpm create rune-app my-cli --yes --no-git

npm

# Skip dependency installation
npm create rune-app@latest my-cli -- --yes --no-install

# Skip git initialization
npm create rune-app@latest my-cli -- --yes --no-git

yarn

# Skip dependency installation
yarn create rune-app my-cli --yes --no-install

# Skip git initialization
yarn create rune-app my-cli --yes --no-git

bun

# Skip dependency installation
bun create rune-app my-cli --yes --no-install

# Skip git initialization
bun create rune-app my-cli --yes --no-git

These options also work in interactive mode — any explicitly provided flag will skip its corresponding prompt.