FAQ・トラブルシューティング
mcms-cliを使うときに迷いやすい点と、代表的なトラブルの確認方法をまとめます。公式ツールとの関係、実行コマンド名、認証先の確認、プロファイルとAPIキーの役割、書き込み前の検証、bulk操作のpayload検証、再試行、型生成ツールの選び方を質問形式で確認できます。
microCMS公式のCLIですか
いいえ。mcms-cliは非公式のコミュニティ製プロジェクトであり、microCMS公式とは無関係です。
インストールしたのにmcms-cliコマンドが見つかりません
実行するコマンド名はmcms-cliではなくmicrocmsです。
microcms --help
microcms --version認証先が想定どおりか確認したい
microcms auth status --json
microcms config doctor --json選択中プロファイル、service domain、APIキーの取得元を確認します。APIキーそのものは表示されません。
profile addだけで認証できますか
できません。profile addが保存するのはservice domainです。APIキーはauth loginでOSキーチェーンへ保存するか、環境変数で渡してください。
書き込み前に何を確認すればよいですか
次の順番を基本にします。
auth statusとconfig doctorschema pullvalidate- 書き込みコマンドの
--dry-run .ok == trueと終了コードの確認- 本実行
content getまたはcontent listで反映確認
content bulk --dry-runだけでpayloadも検証されますか
通常のdry-runは操作定義の構造を検証します。各endpointのスキーマに対してpayloadも検証するには、--validate-payloadまたは--strict-warningsを指定します。
APIキーを--api-keyで指定してよいですか
コマンド引数はシェル履歴やプロセス一覧に露出する可能性があります。CIでは環境変数、ローカルではOSキーチェーン、パイプ処理では--api-key-stdinを利用してください。
ネットワークエラーを再試行できますか
--retryは、既定でGETなどのretry-safeなリクエストに適用されます。書き込みを安易に自動再試行せず、結果とremoteの状態を確認してください。
型生成だけが目的です
mcms-cliでも型生成できますが、複雑なリレーションやリピーターを含む高度な型生成が主目的の場合は、READMEで案内されている専用CLIも比較してください。