​
CLI のインストール

前提条件: 事前に Node.js をインストールしてください。
1

CLI をインストールする

CLI をインストールするには、次のコマンドを実行します:
npm i -g mint
2

ローカルでプレビューする

ドキュメントのディレクトリ（docs.json がある場所）に移動し、次のコマンドを実行します:
mint dev
ドキュメントのローカルプレビューは http://localhost:3000 で確認できます。
また、CLI をグローバルにインストールしたくない場合は、ワンタイムのスクリプトとして次を実行できます: 
npx mint dev

​
更新

ローカルのプレビューが本番環境のウェブ上の表示内容と同期していない場合は、ローカルのCLIを更新してください： 
mint update
ローカルのバージョンで mint update コマンドが利用できない場合は、最新バージョンのCLIを再インストールしてください： 
npm i -g mint@latest

​
カスタムポート

デフォルトでは CLI はポート 3000 を使用します。--port フラグでポートを指定できます。たとえば、CLI をポート 3333 で実行するには次のコマンドを使用します: 
mint dev --port 3333
すでに使用中のポートを指定した場合は、次に利用可能なポートが使用されます: 
Port 3000 is already in use. Trying 3001 instead.

​
特定のグループとしてプレビューする

ドキュメントへのアクセスを部分認証で制限している場合は、--group [groupname] フラグを使って特定の認証グループとしてプレビューできます。 たとえば、admin という名前のグループがある場合は、次のコマンドでそのグループのメンバーとしてプレビューできます。 
mint dev --group admin

​
追加のコマンド

mint dev が最もよく使われるコマンドですが、ドキュメント管理には他にも使えるコマンドがあります。 CLI はドキュメント内の参照リンクの検証を支援します。リンク切れを特定するには、次のコマンドを実行します: 
mint broken-links

​
OpenAPI仕様のチェック

次のコマンドで、CLIを使ってOpenAPIファイルのエラーを確認できます。 
mint openapi-check <openapiFilenameOrUrl>
ファイル名（例：./openapi.yaml）またはURL（例：https://petstore3.swagger.io/api/v3/openapi.json）を指定できます。

​
ファイル名の変更

次のコマンドで、ファイル名の変更と、ファイルへのすべての参照の更新を行えます。 
mint rename <oldFilename> <newFilename>

​
MDX エンドポイントページの移行

次のコマンドで、OpenAPI 仕様から自動生成されるページへ MDX エンドポイントページを移行できます。 
mint migrate-mdx
このコマンドは、各 MDX エンドポイントページを docs.json で定義された自動生成ページに変換し、MDX コンテンツを OpenAPI 仕様の x-mint 拡張に移動し、ナビゲーションを更新します。詳しくは Migrating from MDX を参照してください。

​
フォーマット

ローカル開発時は、IDE の拡張機能を使って MDX ファイルを認識・整形することをおすすめします。 Cursor、Windsurf、または VS Code をお使いの場合は、シンタックスハイライトに MDX VS Code extension、コード整形に Prettier をおすすめします。 JetBrains をお使いの場合は、シンタックスハイライトに MDX IntelliJ IDEA plugin、コード整形用に Prettier の設定を行うことをおすすめします。

​
トラブルシューティング