Rune のインストール

create rune-app コマンドを実行していくつかの質問に回答することにより、新しい Rune プロジェクトを素早く作成できます。

前提条件

• Node.js - v22.12.0 以上
• ターミナル - Rune プロジェクトの初期化にはコマンドライン操作が必要です

インストール

1. 新しいプロジェクトの作成

   ターミナルで以下のコマンドを実行し、新しい Rune プロジェクトを作成します。

   pnpm

   pnpm create rune-app

   npm

   npm create rune-app@latest

   yarn

   yarn create rune-app

   bun

   bun create rune-app

   プロジェクト名の入力、依存関係のインストール、git リポジトリの初期化について対話形式で確認されます。

   プロジェクト名は引数として直接渡すこともできます。

   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

   プロジェクト名の代わりに . を渡すと、現在のディレクトリにプロジェクトを作成できます。テンプレートと衝突するファイル（.gitignore、package.json、tsconfig.json、src/ など）が含まれているとエラーになります。

   pnpm

   pnpm create rune-app .

   npm

   npm create rune-app@latest .

   yarn

   yarn create rune-app .

   bun

   bun create rune-app .

2. コマンドの実行

   プロジェクトディレクトリに移動し、スターターに含まれる hello コマンドを実行して動作を確認します。

   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

   npm run では、実行したいコマンドの引数を -- の後ろに渡します。

   npm run start -- hello  # hello コマンドを実行
   npm run start -- --help  # my-cli コマンドのヘルプを表示
   npm run start -- hello --help  # hello コマンドのヘルプを表示

   以下のような出力が表示されれば成功です。

   hello from my-cli

非対話モード

--yes（-y）フラグを渡すか、CI、エージェント環境、または TTY のない環境で実行すると、対話プロンプトをスキップしてデフォルト値で実行されます。

pnpm

pnpm create rune-app my-cli --yes

# 現在のディレクトリにプロジェクトを作成する場合
pnpm create rune-app . --yes

npm

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

# 現在のディレクトリにプロジェクトを作成する場合
npm create rune-app@latest . -- --yes

yarn

yarn create rune-app my-cli --yes

# 現在のディレクトリにプロジェクトを作成する場合
yarn create rune-app . --yes

bun

bun create rune-app my-cli --yes

# 現在のディレクトリにプロジェクトを作成する場合
bun create rune-app . --yes

npm

npm create（および npm init）はフラグを npm 自体が消費してしまうため、-- セパレータでパッケージ引数とフラグを区切る必要があります。他のパッケージマネージャはフラグをそのまま転送するため、-- セパレータは不要です。

個別の動作はオプションで制御できます。

オプション	デフォルト	説明
--yes / -y	false	すべてのプロンプトをスキップ
--install / --no-install	true	依存関係のインストール
--git / --no-git	true	git リポジトリの初期化

pnpm

# 依存関係のインストールをスキップ
pnpm create rune-app my-cli --yes --no-install

# git の初期化をスキップ
pnpm create rune-app my-cli --yes --no-git

npm

# 依存関係のインストールをスキップ
npm create rune-app@latest my-cli -- --yes --no-install

# git の初期化をスキップ
npm create rune-app@latest my-cli -- --yes --no-git

yarn

# 依存関係のインストールをスキップ
yarn create rune-app my-cli --yes --no-install

# git の初期化をスキップ
yarn create rune-app my-cli --yes --no-git

bun

# 依存関係のインストールをスキップ
bun create rune-app my-cli --yes --no-install

# git の初期化をスキップ
bun create rune-app my-cli --yes --no-git

対話モードでもこれらのオプションを渡すと、該当するプロンプトが省略されます。