CLI コマンド リファレンス

このページでは、mockkit CLI の各コマンドを解説します。インストール方法などは使いはじめるを参照してください。

mockkit init [projectDir]

mockkit.json を作成（または上書き）して、既存プロジェクトを MockKit 用に初期化するコマンドです。

mockkit init [projectDir]

• projectDir を省略した場合は、現在のディレクトリが対象になります。
• すでに mockkit.json がある場合は、上書き確認が表示されます。

対話で設定する項目

init 実行時には、次の内容を順に質問されます。

• プロジェクト名
• 使用する静的サイトジェネレータ（manual または nuxt）
• 出力先ディレクトリ（build.distDir）
• 公開ディレクトリ（build.publicDir）
• 開発サーバのポート（build.devPort）
• 開発コマンド（build.devCommand）
• 静的生成コマンド（build.generateCommand）

nuxt を選んだ場合

nuxt を選択すると、次のいずれかの設定ファイルから既定値の検出を試みます。

• nuxt.config.ts
• nuxt.config.js
• nuxt.config.mjs
• nuxt.config.cjs

どれも見つからない場合は、init は中断されます。

mockkit configure [--clear]

MockKit に公開するための API キーを保存・削除するコマンドです。

mockkit configure [--clear]

• API Key は ~/.mockkit/credentials.json に保存されます。
• --clear を付けると、保存済みの API キーを削除します。

mockkit publish [projectDir] [--site-id <id>] [--dist-path <path>]

静的サイトジェネレータによるビルド結果を MockKit にアップロードするコマンドです。

mockkit publish [projectDir] [--site-id <id>] [--dist-path <path>]

• projectDir を省略した場合は、現在のディレクトリが対象です。
• --site-id <id> を指定すると、その ID のサイトに新しいバージョンとして公開します。
• --dist-path <path> を指定すると、アップロード対象ディレクトリを明示できます。

実行条件

• projectDir に mockkit.json が存在すること
• dist-path が存在し、ディレクトリであること
• dist-path 配下に少なくとも1つ以上のファイルが存在すること

サイト ID の決定順序

--site-id を指定しない場合、サイト ID は次の順で決まります。

1. mockkit.json の siteId
2. API から取得したサイト一覧からの対話選択
3. 対話での新規サイト作成

決定したサイト ID は mockkit.json に記録されます。

mockkit dev [projectDir] [--host <host>]

開発サーバを開始し、mockkit-manifest.json の同期を維持するコマンドです。

mockkit dev [projectDir] [--host <host>]

• projectDir を省略した場合は、現在のディレクトリが対象です。
• --host <host> を指定すると、MockKit Viewer にホストの bind アドレス（例: 0.0.0.0）を渡せます。
• mockkit.json の build.devCommand を実行します。
• MockKit Viewer の開発サーバを起動します。
• mockkit.json の変更を監視し、更新時に build.publicDir 配下の mockkit-manifest.json を再生成します。

mockkit generate [projectDir]

mockkit.json に定義された静的生成コマンドを実行するコマンドです。

mockkit generate [projectDir]

• projectDir を省略した場合は、現在のディレクトリが対象です。
• build.generateCommand 実行前に、build.publicDir 配下の mockkit-manifest.json を再生成します。

mockkit manifest [projectDir]

mockkit.json から mockkit-manifest.json を同期生成するコマンドです。

mockkit manifest [projectDir]

• projectDir を省略した場合は、現在のディレクトリが対象です。