Install Rune

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

Prerequisites

• Node.js - v24.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

2. Run a command

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

   pnpm

   cd my-cli
   pnpm run start hello

   npm

   cd my-cli
   npm run start -- hello

   yarn

   cd my-cli
   yarn run start hello

   bun

   cd my-cli
   bun run start hello

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

   hello from my-cli