セットアップと作成

upgrade --check

Upgrade Lab はチェック専用の事前検証で、プロジェクト、node_modules、dist、.riebeckite を変更しません。--check は互換性のために受け付けられますが、upgrade は常にチェックを実行するため省略できます。

npm exec -- riebeckite upgrade --to 0.0.35
npm exec -- riebeckite upgrade --to latest --json

レポートでは依存関係・ peerDependencies ・ Node engines の解決、tsconfig.json がある場合の TypeScript 検査、riebeckite check、diagnostics、本番のフルビルド、生成 URL、出力ファイルを比較します。READY は両環境が成功し、URL と出力ファイルに差分がない状態です。候補版の失敗または差分は REVIEW REQUIRED、隔離した依存関係の解決失敗は BLOCKED、baseline の失敗や安全に実行できない検査は UNVERIFIED です。

対応するのは、package-lock.json と pnpm-lock.yaml のどちらか一方だけがある npm / pnpm プロジェクトです。symlink とプロジェクト外の content root は複製しません。プロジェクト外の content root は境界を越えずに UNVERIFIED を返し、symlink の content root は例外となり BLOCKED になります。install scripts、pnpmfile、デプロイ、ブラウザー E2E は実行しません。一時ディレクトリはセキュリティ sandbox ではなく、ビルドはサイト自身の設定とプラグインを実行します。子プロセスには実行に必要な PATH、OS の一時ディレクトリ変数、一時的なホームディレクトリ変数、および隔離した npm cache と user config だけを渡します。これにより環境変数の秘密情報が意図せず渡ることは抑えられますが、信頼できないビルドコードを安全に実行できるわけではありません。

init

init は、設定、Vite/HonoX のアプリケーションシェル、ルート、スタイルシート、スターターコンテンツを含む自己完結したサイトを、対象ディレクトリに生成します。対象ディレクトリの既定値はカレントディレクトリです。生成されたサイトは、Riebeckite モノレポに依存しない自己完結したアプリケーションです。

npm exec riebeckite init

別の場所にサイトを作る場合は、ディレクトリを指定します。

npm exec riebeckite init my-site

依存関係をインストールしてから、生成したサイトで check と build を実行してください。

プリセットの選び方

構成は --preset <name> で選びます（既定値: starter）。

npm exec -- riebeckite init my-site --preset starter

--list-presets を実行すると、利用できるプリセットとその説明を確認できます。

npm exec -- riebeckite init --list-presets

Feature Packを追加する

--features <names> には、任意の Pack をカンマ区切りで指定します。指定できるのは knowledge、diagrams、media、i18n です。none は Pack を追加しません。プリセットがすでに選んだ Plugin と重複する Pack は無視されます。

npm exec -- riebeckite init my-site --preset portfolio --features diagrams,i18n

プロジェクトファイルの選び方

プロジェクトファイルはプリセットとは別に、--utilities <names> で選びます。値には gitignore、editorconfig、gitattributes、biome、npmrc、vscode をカンマ区切りで指定します。

npm exec -- riebeckite init my-site --utilities editorconfig,npmrc,vscode

既定値は gitignore,editorconfig,gitattributes,biome で、none を指定すると何も書き込みません。対話モードでは、Customize extra project files? で Yes を選ぶと、Extra project files の質問で既定のセットを個別に切り替えられます。

生成先にファイルがすでにある場合

init は、生成対象のファイルがすでにあるディレクトリには、--force を指定しない限り書き込みません。

npm exec -- riebeckite init my-site --force

--force は既存ファイルに影響するため、使用する前に内容を確認してください。

create-riebeckite

create-riebeckite パッケージを使うと、npx create-riebeckite から同じジェネレーターを実行できます。--preset、--features、--list-presets フラグも同じように受け付けます。

npx create-riebeckite

フォルダ名を渡すと（例: npx create-riebeckite my-site --preset starter）、質問は省略され、依存関係もインストールされません。生成したフォルダで npm install を実行してから check と build を使ってください。

対話モードでは、コンテンツソースを尋ねたあと、デプロイ方法を尋ねます。

Deploy now? で Yes を選ぶと、雛形の生成直後にビルドと riebeckite publish run --execute が実行されます。Later を選ぶとサイトの生成だけを行い、次のコマンドで公開します。

npm exec riebeckite build
npm exec -- riebeckite publish run --execute

サイトを生成したら、設定を確認します。対話式では既定で依存関係がインストールされます。インストールの質問で No を選んだ場合は、先に npm install を実行してください。

npm exec riebeckite check
npm exec riebeckite build

create

create はジェネレーターの統一エントリポイントです。TTY では、サイト、プラグイン、テーマ、PageType、コンポーネントのどれを作成するかを尋ね、生成ロジックを重複させずに対応するジェネレーターへ処理を委譲します。

riebeckite create
riebeckite create site my-site --preset starter
riebeckite create plugin reading-time --features transform
riebeckite create theme my-theme --template blog --register
riebeckite create page-type glossary --path /glossary/ --with-tests
riebeckite create component note-card --target site --with-styles
riebeckite create --help

スクリプトからは対象を明示してください。create site は引数を create-riebeckite に渡します。create plugin と create theme は既存のオプションと非 TTY での検証を維持します。create page-type はプラグインの PageType を作成し、create component はサイト、プラグイン、テーマの責務境界を守ります。

create theme は既定で --template minimal を使い、ダークモード、テスト、ドキュメントを有効にします。無効にするには --no-dark-mode、--no-tests、--no-docs を指定します。create component の --target は既定で site です。