mcms-cli
mcms-cliは、microCMSのコンテンツ取得・更新、APIスキーマの保存、TypeScript型やJSON Schemaの生成をコマンドラインから行うコミュニティ製ツールです。導入方法から、安全な書き込み手順、AIやCIで機械的に結果を判定する方法までを、実行例とともに案内します。
mcms-cliは、microCMSのContent APIとManagement APIをコマンドラインから操作するための非公式CLIです。この検証ではv0.7.4を参照しています。
このCLIはmicroCMS公式の製品ではなく、コミュニティで開発されているプロジェクトです。本番利用前に、対象サービスで権限と動作を確認してください。
何を解決するツールか
管理画面を使わずに、コンテンツの取得・検証・作成・更新や、スキーマの取得・比較・型生成を実行できます。特に次の用途を想定しています。
- CIでコンテンツやスキーマの差分を検査する
- AIエージェントから機械判定可能な形でmicroCMSを操作する
- 複数環境の認証情報をプロファイルで切り替える
- 書き込み前にpayloadと実行内容を検証する
- 公式ドキュメントやCLI仕様をコマンドラインから検索する
名前の違い
| 名前 | 意味 |
|---|---|
mcms-cli |
GitHubリポジトリ名とローカル識別子 |
@mrmtsu/mcms-cli |
npmパッケージ名 |
microcms |
インストール後に実行するコマンド名 |
設計上の特徴
CLIの成功結果はok、data、metaを持つJSONとして返せます。人間が読むメッセージを解析せず、.ok == trueと終了コードで処理を分岐できるため、AIやCIから扱いやすくなっています。
{
"ok": true,
"data": {},
"meta": {
"requestId": null,
"version": "0.x"
}
}次は、インストールと認証を設定します。