CLI
ministaのCLIは、開発サーバーの起動、静的ファイルの生成、ページ構成の検査を行います。プロジェクトへインストールしたCLIは、npm scriptsまたはnpx ministaから実行できます。
Table of Contents
- コマンド一覧
- 開発・ビルド・プレビュー
- check:ページ構成を検査する
- inspect:構成を表示する
- explain:要素同士の関係を確認する
- agents:利用ガイドを取得する
- 独自オプション
- 作業用ディレクトリと保存される情報
コマンド一覧
表の[root]は省略可能なプロジェクトルートです。コマンド入力時に省略すると、現在のディレクトリを使います。
| コマンド | 内容 |
|---|---|
minista [root] | 開発サーバーを起動 |
minista build [root] | 静的HTMLとアセットを生成 |
minista preview [root] | ビルド済みファイルをローカルで配信 |
minista check [root] | ページやルートの問題を検査 |
minista inspect [root] | Project Graphの概要を表示 |
minista explain <node-id> [root] | 指定したGraphの要素の関係を表示 |
minista agents [root] | インストール済みバージョンのagent向けガイドを表示 |
開発・ビルド・プレビュー
{
"scripts": {
"dev": "minista",
"build": "minista build",
"preview": "minista preview",
"check": "minista check"
}
}npm run dev
npm run build
npm run preview開発サーバーはCtrl + Cで停止します。プレビューは既存のビルド結果を確認するためのもので、ソースの変更を自動的にビルドしません。
minista buildは、描画/ブラウザ向けの環境を一つのViteアプリケーションビルドで順にビルドします。出力先はデフォルトでdist/です。build.outDirで変更できます。
プロジェクトルートや開発サーバーのオプションは次のように指定します。
npx minista site --port 3000
npx minista build site
npx minista preview site --port 4173開発時・ビルド・previewではViteのCLIオプションを利用します。通常はministaが処理し、変換できないオプションでは外部のVite CLIへフォールバックする場合があります。
check:ページ構成を検査する
npx minista check
npx minista check --jsonページモジュールとgetStaticData()を評価し、ルートやページの問題を検査します。エラーがある場合は終了コードが非0になります。TypeScriptの型チェックや、ビルド結果のブラウザ確認とは別の検査です。
--jsonを付けると機械可読な結果を標準出力へ返します。診断には安定したcode、severity、messageが含まれ、内容に応じてhint、location、phase、nodeIdなども付与されます。
inspect:構成を表示する
npx minista inspect --jsonソースからProject Graphを構築し、ページやルートなどの構成を表示します。通常のinspectはページモジュールとgetStaticData()を実行します。
最後に成功したビルドの情報だけを読みたい場合は、--manifestを指定します。
npx minista inspect --manifest --jsonこの形式ではViteサーバーや利用者のモジュールを起動しません。保存済みmanifestがない場合は自動ビルドせず、MINISTA_MANIFEST_NOT_FOUNDを返します。ソースを変更した後でも、manifestは次の成功ビルドまで更新されません。
explain:要素同士の関係を確認する
npx minista explain "page:route%3Asrc/pages/index.jsx#/" --json指定したGraphの要素の関係を表示します。例のIDはsrc/pages/index.jsxから生成したルートページのものです。対象プロジェクトのinspect --jsonで得たIDを引用符で囲んで渡してください。
通常のcheck inspectと同じく利用者のモジュールを評価するため、データ取得に必要な環境変数などを用意します。
agents:利用ガイドを取得する
npx minista agents
npx minista agents --json
npx minista agents --writeagentsはministaに同梱されたガイドを表示します。設定やページモジュールを評価しません。
--jsonでは、バージョン、ガイドの本文とパス、作業用ディレクトリの場所、manifestと診断ファイルのパス・存在状態を取得できます。表示だけではファイルを作成しません。
--writeはプロジェクトのAGENTS.mdへ案内を追加・更新します。既存のminista管理ブロックだけを更新し、それ以外の記述は保持します。--write --jsonで変更結果もJSONとして取得できます。create-ministaは同じ案内を自動生成します。
サイト制作の依頼例と確認の進め方はエージェントを使った制作を参照してください。
独自オプション
| オプション | 対象 | 内容 |
|---|---|---|
--json | check inspect explain agents | 結果をJSON形式で出力 |
--manifest | inspect | 保存済みmanifestだけを読み取る |
--write | agents | AGENTS.mdへ案内を追加・更新 |
v4の--oneBuildは削除されました。指定するとMINISTA_CLI_OPTION_REMOVEDで終了します。標準のminista buildを使用してください。
作業用ディレクトリと保存される情報
保存先はプロジェクトルート直下のpackage.jsonの有無で決まります。
| 条件 | 保存先 |
|---|---|
ルートにpackage.jsonがある | node_modules/.minista/ |
ルートにpackage.jsonがない | .minista/ |
checkは検査結果をdiagnostics.jsonへ保存します。成功したbuildは構成と出力情報をmanifest.jsonへ保存し、ビルドの診断もdiagnostics.jsonへ記録します。
manifestは最後の成功ビルド、diagnosticsは直近に記録したcheckまたはビルドの結果なので、同じ実行の情報とは限りません。作業用ディレクトリは手編集せず、サイトの公開物にも含めません。